WarningCodeState Class Reference

#include <engine_parts.h>

Collaboration diagram for WarningCodeState:

Public Member Functions
	WarningCodeState ()
void	addWarningCode (ObdCode code)
bool	isWarningNow () const
bool	isWarningNow (ObdCode code) const
void	clear ()

Data Fields
int	warningCounter
ObdCode	lastErrorCode = ObdCode::None
Timer	timeSinceLastWarning
warningBuffer_t	recentWarnings

Detailed Description

Definition at line 55 of file engine_parts.h.

Constructor & Destructor Documentation

WarningCodeState()

WarningCodeState::WarningCodeState

(

)

Definition at line 26 of file engine2.cpp.

                                   {
    clear();
}

Here is the call graph for this function:

Member Function Documentation

addWarningCode()

void WarningCodeState::addWarningCode

(

ObdCode

code

)

Definition at line 36 of file engine2.cpp.

                                                  {
    warningCounter++;
    lastErrorCode = code;
 
    warning_t* existing = recentWarnings.find(code);
 
    if (!existing) {
        chibios_rt::CriticalSectionLocker csl;
 
        // Add the code to the list
        existing = recentWarnings.add(warning_t(code));
    }
 
    if (existing) {
        // Reset the timer on the code to now
        existing->LastTriggered.reset();
    }
 
    // Reset the "any warning" timer too
    timeSinceLastWarning.reset();
}

Referenced by firmwareError(), and warning().

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

void WarningCodeState::clear

(

)

Definition at line 30 of file engine2.cpp.

                             {
    warningCounter = 0;
    lastErrorCode = ObdCode::None;
    recentWarnings.clear();
}

Referenced by WarningCodeState().

Here is the call graph for this function:

Here is the caller graph for this function:

isWarningNow() [1/2]

bool WarningCodeState::isWarningNow

(

)

const

Parameters

forIndicator

if we want to retrieving value for TS indicator, this case a minimal period is applued

Definition at line 61 of file engine2.cpp.

                                          {
    int period = maxI(3, engineConfiguration->warningPeriod);
 
    return !timeSinceLastWarning.hasElapsedSec(period);
}

Referenced by updateTunerStudioState(), and warning().

Here is the caller graph for this function:

isWarningNow() [2/2]

bool WarningCodeState::isWarningNow

(

ObdCode

code

)

const

Definition at line 68 of file engine2.cpp.

                                                      {
    warning_t* warn = recentWarnings.find(code);
 
    // No warning found at all
    if (!warn) {
        return false;
    }
 
    // If the warning is old, it is not active
    return !warn->LastTriggered.hasElapsedSec(maxI(3, engineConfiguration->warningPeriod));
}

Here is the call graph for this function:

Field Documentation

lastErrorCode

ObdCode WarningCodeState::lastErrorCode = ObdCode::None

Definition at line 63 of file engine_parts.h.

Referenced by addWarningCode(), clear(), handleTestCommand(), obdOnCanPacketRx(), populateFrame(), and updateWarningCodes().

recentWarnings

warningBuffer_t WarningCodeState::recentWarnings

Definition at line 68 of file engine_parts.h.

Referenced by addWarningCode(), clear(), isWarningNow(), and updateWarningCodes().

timeSinceLastWarning

Timer WarningCodeState::timeSinceLastWarning

Definition at line 65 of file engine_parts.h.

Referenced by addWarningCode(), and isWarningNow().

warningCounter

int WarningCodeState::warningCounter

Definition at line 62 of file engine_parts.h.

Referenced by addWarningCode(), clear(), populateFrame(), and updateWarningCodes().

---

The documentation for this class was generated from the following files:

• controllers/algo/engine_parts.h
• controllers/algo/engine2.cpp