bre20::AfrRule Class Reference

See Datalogger Extension for usage guidelines. More...

Inheritance diagram for bre20::AfrRule:

bre20::Rule List of all members.

Public Member Functions

 AfrRule (String *sensorname)
int getIndex ()
void setIndex (int i)
String * getName ()
void setName (String *sensorname)
void setAfrKey (LoggerKey *afrkey)
virtual String * modifiedFields ()
virtual void setupRule (Form *frm)
virtual bool updateRule (Form *frm)
virtual bool executeReplay (String *keys[], Hashtable *vals)
virtual bool executeRule (Form *frm)=0

Protected Attributes

int index
String * name
LoggerKeyafrKey
 just use this supplied LoggerKey object to set afr value.

Detailed Description

See Datalogger Extension for usage guidelines.


Constructor & Destructor Documentation

bre20::AfrRule::AfrRule String *  sensorname  ) 
 


Member Function Documentation

virtual bool bre20::AfrRule::executeReplay String *  keys[],
Hashtable *  vals
[virtual]
 

This function is the same as executeRule() but happens when a log is being replayed. It is necessary for updating gauges when replaying. The text based values are automatically put into their respective places when replaying.

Parameters:
keys The labels from the log file.
values has values from the file mapped to each key.
Returns:
true if executed properly

Implements bre20::Rule.

virtual bool bre20::AfrRule::executeRule Form *  frm  )  [pure virtual]
 

This function is called when a rule needs to be executed.

In the context of the Datalogger, it will be called each time the logger gets data back from an ECU. You are passed the Datalogger and will then be able to modify the data from the ecu before its displayed.

Additionally if your rule needs to deal with a gauge you must update that gauge in this function.

Parameters:
frm The form you will be given to grab values from or act on
Returns:
true if it executed properly, false if otherwise

Implements bre20::Rule.

int bre20::AfrRule::getIndex  ) 
 

String* bre20::AfrRule::getName  ) 
 

virtual String* bre20::AfrRule::modifiedFields  )  [virtual]
 

A string that explains what fields you are modifying. see the rule field explanation.

If you only modify one field just return the name of that field. If concatination is necessary, the fields will be separated by colons ( : ). i.e.

                return "rpm:index:tps";

Returns:
A string that explains what fields you are modifying.

Implements bre20::Rule.

void bre20::AfrRule::setAfrKey LoggerKey afrkey  ) 
 

void bre20::AfrRule::setIndex int  i  ) 
 

void bre20::AfrRule::setName String *  sensorname  ) 
 

virtual void bre20::AfrRule::setupRule Form *  frm  )  [virtual]
 

Called the first time the FormWithRules form knows about your rule.

Parameters:
frm The form you will be given to grab values from or act on

Implements bre20::Rule.

virtual bool bre20::AfrRule::updateRule Form *  frm  )  [virtual]
 

This function is called when a rule needs to be updated.

In the context of the Datalogger, it will be called each time the DatalogOptions dialog is opened and closed. You are passed the Datalogger and will update the rule's display as necessary (such as with a change in the units).

Additionally if your rule needs to deal with a gauge you must update that gauge in this function.

Implements bre20::Rule.


Member Data Documentation

LoggerKey* bre20::AfrRule::afrKey [protected]
 

just use this supplied LoggerKey object to set afr value.

int bre20::AfrRule::index [protected]
 

String* bre20::AfrRule::name [protected]
 




BRE Documentation Home