CARMA C++
carma::monitor::MonitorPointEnum Class Referenceabstract

Abstract base class for any enumerated constants, like state machines. More...

#include <carma/monitor/monitorPointSpecializations.h>

Inheritance diagram for carma::monitor::MonitorPointEnum:
carma::monitor::MonitorPoint carma::monitor::MonitorComponent

Public Types

typedef int AccumReportType
 
typedef MonitorPointAverageEnum AccumType
 
- Public Types inherited from carma::monitor::MonitorPoint
enum  BLANKING_FLAGGING {
  UNDETERMINED, OK, BLANKED, FLAGGED,
  BLANKED_FLAGGED, MAX_BLANKING_FLAGGING
}
 Blanking/flagging status of the data. More...
 
enum  MONITOR_POINT_TYPE { MONITOR, CONTROL }
 Monitor point type. More...
 
enum  VALIDITY {
  INVALID_NO_DATA, INVALID_NO_HW, INVALID_HW_BAD, VALID,
  VALID_NOT_CHECKED, VALID_GOOD, VALID_WARNING, VALID_ERROR,
  VALID_WARNING_LOW, VALID_WARNING_HIGH, VALID_ERROR_LOW, VALID_ERROR_HIGH,
  MAX_VALIDITY
}
 Validity states of the data value. More...
 
- Public Types inherited from carma::monitor::MonitorComponent
enum  ARCHIVE_PRIORITY {
  VITAL, USEFUL, NORMAL, DEBUG,
  VERBOSE, DEFAULT, DONTARCHIVE
}
 Archiving priority. More...
 

Public Member Functions

virtual void accumulate (AccumType &accum) const
 Accumulate values from current monitor point for computing averages. More...
 
virtual void accumulateAverage (AccumType &accum)
 Accumulates pre-calculated average value from current monitor point for computing averages. More...
 
virtual enum MonitorPoint::VALIDITY accumulateSample (AccumType &accum, int index) const
 Accumulates data from one monitor point sample (sample index == index) belonging this monitor point. More...
 
void addEnumErrorHighDefault (const long enumValue)
 Add default error high threshold. More...
 
void addEnumErrorLowDefault (const long enumValue)
 Add default error low threshold. More...
 
void addEnumWarnHighDefault (const long enumValue)
 Add default warning high threshold. More...
 
void addEnumWarnLowDefault (const long enumValue)
 Add default warning low threshold. More...
 
virtual enum MonitorPoint::VALIDITY evaluateSampleTolerance (const MonitorPointThreshold &threshold, int enumVal) const
 Method to return validity for a sample using the range parameters in the MonitorPointThreshold object,. More...
 
virtual void evaluateTolerance (const MonitorPointThreshold &threshold)
 Set the validity flags for the MonitorPoint using the threshold limits stored in the input MonitorPointThreshold object. More...
 
virtual AccumReportType getAccumulatedAverage (const AccumType &accum) const
 Compute average from accumulated values in accumulator object. More...
 
virtual std::string getAccumulatedAverageAsString (const AccumType &accum) const
 Create and return string representation for average accumulated in accumulator object. More...
 
int getAve () const
 
virtual AccumReportType getMaxValue (const AccumType &accum) const
 Returns maximum value from accumulated data in accumulator object. More...
 
virtual AccumReportType getMinValue (const AccumType &accum) const
 Returns minimum value from accumulated data in accumulator object. More...
 
int getNumEnumerations () const
 Get the number of enumerations. More...
 
::std::string getRawStringForEnumValue (int enumValue) const
 
int getValue (int sampleNo) const
 
virtual short getWidth () const
 Get the string length to use when interpreting the value to a string. More...
 
bool isBitmask () const
 Is this monitor point enumeration a bitmask. More...
 
 MonitorPointEnum (const std::string &name, const bool bitmask=false, MONITOR_POINT_TYPE monitorPointType=MONITOR)
 Constructor. More...
 
void removeEnumErrorHighDefault (const long enumValue)
 Remove enum value from default error low threshold. More...
 
void removeEnumErrorLowDefault (const long enumValue)
 Remove enum value from default error high threshold. More...
 
void removeEnumWarnHighDefault (const long enumValue)
 Remove enum value from default warning high threshold. More...
 
void removeEnumWarnLowDefault (const long enumValue)
 Remove enum value from default warning low threshold. More...
 
virtual void resetAccumulator (AccumType &accum) const
 Reset accumulator values from for computing averages. More...
 
void setNumEnumerations (int num)
 Set the number of enumerations. More...
 
void setValue (const long i, int sampleNo) const
 
virtual void updateFrameAverage (ScratchAverages &scratchAvgs)
 Abstract method that updates the average value/validity for the frame. More...
 
 ~MonitorPointEnum ()
 Destructor. More...
 
- Public Member Functions inherited from carma::monitor::MonitorPoint
std::string archivePriorityToString () const
 Get a string for the archive priority for this monitor point. More...
 
void checkThreshold (const MonitorPointThreshold &threshold) const
 Method checks that threshold object corresponds to this monitor point - checks to see that threshold's tagID == this monitor point's tagID, and that value type of threshold == value type of this monitor point. More...
 
void clearComment ()
 Clear all comment attributes for the monitor point. More...
 
virtual std::string dumpSamples (bool includeAverage=true, bool includeValidity=true) const
 Create a string with sample and average values and validities. More...
 
bool errorHighDefaultIsSet () const
 Returns true if a default value was set for errorHigh for this monitor point. More...
 
bool errorLowDefaultIsSet () const
 Returns true if a default value was set for errorLow for this monitor point. More...
 
ARCHIVE_PRIORITY getArchivePriority () const
 Get the archive priority. More...
 
virtual std::string getAverageToString () const =0
 Abstract method that returns the average value as a string. More...
 
virtual VALIDITY getAveValidity () const
 Get the validity for the average. More...
 
BLANKING_FLAGGING getBlankingFlagging () const
 Get the blanking/flagging flag for the average. More...
 
std::string getComment () const
 Get a comment for the monitor point. More...
 
double getCommentTime () const
 Get time last comment was inserted. More...
 
std::string getCommentUser () const
 Get username that generated comment for the monitor point. More...
 
std::string getCoreValueAsString (int sampleIndex=0) const
 Get value as a string using the underlying basic type representation. More...
 
MonitorValue getErrorHighDefault () const
 Get the upper error default threshold. More...
 
MonitorValue getErrorLowDefault () const
 Get the upper error default threshold. More...
 
MonitorPointSample getMonitorPointSample (int sampleIndex) const
 Get the monitor point sample. More...
 
MonitorPointSample getMonitorPointSample0 () const
 
MONITOR_POINT_TYPE getMonitorPointType () const
 Get the type of the monitor point. More...
 
int getNumSamples () const
 Get the number of samples per frame. More...
 
int getNumValidSamples () const
 Get the number of valid samples per frame. More...
 
std::string getPaddedAverageString (int width) const
 Gets the average value as a string, padded to requested width. More...
 
std::string getPaddedAverageString () const
 Gets the average value as a string, padded to internal width. More...
 
std::string getPaddedValueString (int width, int sampleIndex) const
 Gets the data value as a string, padded to requested width. More...
 
std::string getPaddedValueString (int sampleIndex) const
 Gets the data value as a string, padded to internal width. More...
 
short getPrecision () const
 Get the number of digits to the right of the decimal point when translating the value to a string. More...
 
MonitorPointSample getSampleAverage () const
 
tagIDType getTagID () const
 Get the tagID (unique identifier of monitor point). More...
 
std::string getUnits () const
 Get the units string for the monitor point. More...
 
int getUpdateInterval () const
 Get the basic sampling update interval in frames. More...
 
VALIDITY getValidity (int sampleIndex) const
 Get the validity flag for a sample. More...
 
VALIDITY getValidity () const
 
virtual std::string getValueToString (int sampleIndex) const =0
 Abstract method that returns the data value as a string. More...
 
MonitorValueType getValuetype () const
 Get the datatype of the value. More...
 
MonitorValue getWarnHighDefault () const
 Get the upper warning default threshold. More...
 
MonitorValue getWarnLowDefault () const
 Get the lower warning default threshold. More...
 
bool hasAllData () const
 See if all MPs in this component and below have data samples. More...
 
virtual ::std::string hierarchyToString (bool canonical=false, bool verbose=false, bool value=true, int sampleIndex=0, int indent=0, int levels=-1) const
 Dump this and all contained monitor components to a string. More...
 
virtual ::std::string hierarchyToStringAverage (bool canonical=false, bool verbose=false, bool value=true, int indent=0, int levels=-1) const
 Dump this and all contained monitor components to a string. More...
 
virtual void hierarchyToVector (::std::vector< ::std::string > &hierarchyList, bool canonical=false, bool verbose=false, int sampleIndex=0) const
 Dump this and all contained monitor component strings into a map hierarchy. More...
 
bool isAveValid () const
 Check to see if the average is valid. More...
 
virtual bool isMonitorPoint () const
 Identifies this component as a MonitorPoint or any derivative Should be over-ridden by the MonitorPoint class; others that don't derive from MP can use this default implementation. More...
 
bool isPersistent () const
 Returns the persistent state of the data. More...
 
bool isSnapshotAverage () const
 Returns state of snapshot averaging for this MP. More...
 
bool isTimeSeries () const
 Are multiple samples in a frame a time series or an array. More...
 
bool isValid (int sampleIndex) const
 Check if this monitor point validity is any of the valid states. More...
 
bool isValid () const
 
virtual std::string leafToString (bool verbose=false, bool value=true, int sampleIndex=0) const
 Dump all leaf nodes below this component to a string. More...
 
 MonitorPoint (const std::string &name, MonitorValueType valuetype, MONITOR_POINT_TYPE monitorPointType=MONITOR)
 Constructor, name is later used to lookup the tagID. More...
 
virtual std::string monitorPointTags (bool untagged=false) const
 Write list of monitor points and their tagIDs to a string, one monitor point per line. More...
 
std::string monitorPointTypeToString () const
 Get a string representation for the monitor point type of this monitor point. More...
 
virtual bool operator< (const MonitorPoint &rhs) const
 Compares monitor point for precedence to the one passed. More...
 
virtual bool operator== (const MonitorComponent &rhs) const
 Compares monitor point for equality to the monitor component passed. More...
 
virtual bool operator== (const MonitorPoint &rhs) const
 Compares monitor point for equality to the one passed. More...
 
void setAllValidity (VALIDITY validity, bool markMpAsModified=true) const
 Set the validity for all samples and the average. More...
 
void setArchivePriority (ARCHIVE_PRIORITY priority)
 Set the archive priority Priority may be used by archiver to control data volume.,. More...
 
void setAveValidity (VALIDITY validity) const
 Set the validity for the average. More...
 
void setBlankingFlagging (BLANKING_FLAGGING flag) const
 Set the blanking/flagging flag for the average. More...
 
void setComment (const std::string &text)
 Set a comment for the monitor point. More...
 
void setComment (const std::string &text, const std::string &user, double mjd)
 Set all comment attributes for the monitor point. More...
 
void setDefaultArchivePriority (ARCHIVE_PRIORITY priority)
 Set the default archive priority If the archive priority is set to DEFAULT, it is replaced with the new priority. More...
 
void setErrorHighDefault (const MonitorValue threshold)
 Set the upper error default threshold. More...
 
void setErrorLowDefault (const MonitorValue threshold)
 Set the upper error default threshold. More...
 
void setMonitorPointHeader (MonitorPointHeader header)
 Set the monitor point header. More...
 
void setNoData () const
 Recursively mark all data samples as INVALID_NO_DATA. More...
 
virtual void setNumSamples (int nSamples) const
 Set the number of samples per frame. More...
 
void setPersistent (bool persistent)
 Set the persistent state of the data. More...
 
void setPrecision (short precision)
 Set the number of digits to the right of the decimal point when translating the value to a string. More...
 
void setSnapshotAverage (bool state)
 Controls whether averaging is done as a normal true average or if it is just a snapshot of the last value. More...
 
void setTagID (tagIDType tagID, bool assignedOTF)
 Set tagID. More...
 
virtual void setTimeSeries (bool timeSeries)
 Determines whether data should be interpreted as time series or as an array (spectrum) when there are multiple samples per frame. More...
 
void setUnits (const std::string &units)
 Get the units string for the monitor point. More...
 
void setUpdateInterval (int interval)
 Set the basic sampling update interval. More...
 
void setValidity (VALIDITY validity, int sampleIndex=0) const
 Set the validity for a single sample. More...
 
void setWarnHighDefault (const MonitorValue threshold)
 Set the upper warning default threshold. More...
 
void setWarnLowDefault (const MonitorValue threshold)
 Set the lower warning default threshold. More...
 
void setWidth (short width) const
 Set the maximum width(length) of the string for interpreting the value to a string. More...
 
std::string toString (bool canonicalName=false, bool verbose=false, bool value=true, int sampleIndex=0, int indent=0) const
 Write this monitor component to a string. More...
 
std::string toStringAverage (bool canonicalName=false, bool verbose=false, bool value=true, int indent=0) const
 Write this monitor component to a string, using frame average values. More...
 
virtual std::string toStringShort (int sampleIndex=0) const
 Dumps name and value of monitor point as a short string (name=value). More...
 
std::string valuetypeToString () const
 Get a string representation for the datatype of this monitor point. More...
 
bool warnHighDefaultIsSet () const
 Returns true if a default value was set for warnHigh for this monitor point. More...
 
bool warnLowDefaultIsSet () const
 Returns true if a default value was set for warnLow for this monitor point. More...
 
virtual ~MonitorPoint ()
 Destructor. More...
 
- Public Member Functions inherited from carma::monitor::MonitorComponent
const std::string & getCanonicalName () const
 Get the canonical component name. More...
 
virtual const std::string & getDescription () const
 Get the verbose description of the monitor component. More...
 
virtual const std::string & getLongName () const
 Get the long name of the monitor component. More...
 
virtual const std::string & getName () const
 Get the component name (leaf part of canonical name). More...
 
virtual std::string getPhysicalDeviceName () const
 Get the physical device name, if one exists. More...
 
std::string getPhysicalDeviceString () const
 Get the physical device name, if one exists, enclosed in parentheses. More...
 
std::string getPhysicalName () const
 Get the physical name, which is location.device.component or if there is no associated physical device it is just component name. More...
 
virtual const std::string & getShortName () const
 Get the short name of the monitor component. More...
 
virtual bool isSubsystem () const
 Check if the component is a MonitorSubsystem. More...
 
 MonitorComponent (const std::string &name)
 Constructor. More...
 
bool operator!= (const MonitorComponent &component) const
 Checks if components are not equal. More...
 
virtual void setCanonicalName (const std::string &parents)
 Recursively set the canonical component name for this and all below. More...
 
void setDescription (const std::string &text)
 Set the verbose description of the monitor component. More...
 
void setLongName (const std::string &name)
 Set the long name of the monitor component. More...
 
void setName (const std::string &name)
 Set the leaf part of the canonical name of the monitor component. More...
 
void setShortName (const std::string &name)
 Set the short name of the monitor component. More...
 
void setShortName (const std::string &name, int index)
 Set the short name of the monitor component, with an index appended. More...
 
virtual std::string transportStatisticsToString (bool canonical=false) const
 Dump end-toe-end transport statistics (if available). More...
 
virtual ~MonitorComponent ()
 Destructor. More...
 

Protected Member Functions

virtual std::string convertToString (int enumValue) const =0
 Convert an integer value, interpreted as an enum, into a string. More...
 
- Protected Member Functions inherited from carma::monitor::MonitorPoint
void clearAllDefaults ()
 Clears all default threshold values (makes them zero) and sets thresholdFlags_ to THRESHOLD_NONE_SET. More...
 
bool getAveBoolean () const
 
char getAveChar () const
 
::std::complex< float > getAveComplex () const
 
double getAveDouble () const
 
float getAveFloat () const
 
long getAveLong () const
 
long getAveSerialNo () const
 
short getAveShort () const
 
std::string getSnapshotAverageToString () const
 
bool getValueBoolean (int sampleIndex) const
 
char getValueChar (int sampleIndex) const
 
::std::complex< float > getValueComplex (int sampleIndex) const
 
double getValueDouble (int sampleIndex) const
 
float getValueFloat (int sampleIndex) const
 
long getValueLong (int sampleIndex) const
 
long getValueSerialNo () const
 
short getValueShort (int sampleIndex) const
 
MonitorValueStringChunk getValueStringChunk (int sampleIndex) const
 
bool isEqualTo (const MonitorPoint &mp) const
 
void setAve (char d) const
 
void setAve (short d) const
 
void setAve (long d) const
 
void setAve (bool d) const
 
void setAve (float d) const
 
void setAve (double d) const
 
void setAve (const ::std::complex< float > &d) const
 
void setAveSerialNo (long d) const
 
void setValue (char d, int sampleIndex) const
 
void setValue (short d, int sampleIndex) const
 
void setValue (long d, int sampleIndex) const
 
void setValue (bool d, int sampleIndex) const
 
void setValue (float d, int sampleIndex) const
 
void setValue (double d, int sampleIndex) const
 
void setValue (const ::std::complex< float > &d, int sampleIndex) const
 
void setValueSerialNo (long d) const
 
void setValuesStringChunksAndValidities (const MonitorValueStringChunk *chunks, int numChunks, VALIDITY validity) const
 

Additional Inherited Members

- Static Public Member Functions inherited from carma::monitor::MonitorPoint
static std::string blankingFlaggingToString (BLANKING_FLAGGING flag)
 Get a string representation for a blanking/flagging flag. More...
 
static bool isValid (VALIDITY validity)
 Check for any of the valid states. More...
 
static std::string monitorPointTypeToString (MONITOR_POINT_TYPE monitorPointType)
 Get a string representation for a monitor point type. More...
 
static std::string validityToString (VALIDITY validity)
 Get a string representation for a validity. More...
 
static std::string valuetypeToString (MonitorValueType valuetype)
 Get a string representation for a valuetype. More...
 
- Static Public Member Functions inherited from carma::monitor::MonitorComponent
static std::string archivePriorityToString (MonitorComponent::ARCHIVE_PRIORITY priority)
 Get a string representation for an archive priority. More...
 
static std::string convertAllLower (std::string name)
 Convert a name to all lower case. More...
 
- Protected Attributes inherited from carma::monitor::MonitorPoint
bool timeSeries_
 
short width_
 
- Protected Attributes inherited from carma::monitor::MonitorComponent
bool debug_
 

Detailed Description

Abstract base class for any enumerated constants, like state machines.

Enumerated monitor point types should not have more than 32 constants. Enum monitor types that are thresholded can be associated with at most 32 consecutive threshold values. The getValueToString() should return the enumeration as a string. The default width will be the length of the longest string.

Extend from this class and provide:

  1. a constructor that correctly sets the number of enumeration states for your class
  2. the enumerations (MyEnums)
  3. get/set methods that cast to your enum:
    1.  void setValue(MyEnum, int sampleNo=0){
                  MonitorPointEnum::setValue(static_cast<int>(myenum)); }
              
    2.  MyEnum getValue(sampleNo=0) {
                  return static_cast<MyEnum>(MonitorPointEnum::getValue()); }
              
  4. getValueToString(sampleNo=1)

Definition at line 899 of file monitorPointSpecializations.h.

Constructor & Destructor Documentation

carma::monitor::MonitorPointEnum::MonitorPointEnum ( const std::string &  name,
const bool  bitmask = false,
MONITOR_POINT_TYPE  monitorPointType = MONITOR 
)

Constructor.

The derived implementation must set the number of enumerations.

Parameters
namemonitor point name
carma::monitor::MonitorPointEnum::~MonitorPointEnum ( )

Destructor.

Nothing fancy here - the dynamic storage is managed elsewhere.

Definition at line 917 of file monitorPointSpecializations.h.

Member Function Documentation

virtual void carma::monitor::MonitorPointEnum::accumulate ( AccumType accum) const
virtual

Accumulate values from current monitor point for computing averages.

Parameters
accumwill accumulate values over time for computing averages.
Returns
none
virtual void carma::monitor::MonitorPointEnum::accumulateAverage ( AccumType accum)
virtual

Accumulates pre-calculated average value from current monitor point for computing averages.

Parameters
accumwill accumulate values over time for computing averages.
Returns
none
virtual enum MonitorPoint::VALIDITY carma::monitor::MonitorPointEnum::accumulateSample ( AccumType accum,
int  index 
) const
virtual

Accumulates data from one monitor point sample (sample index == index) belonging this monitor point.

Parameters
accumholds data for computing average.
Returns
enum MonitorPoint::VALIDITY validity flag of sample.
See Also
carma::monitor::MonitorPointAverageT
void carma::monitor::MonitorPointEnum::addEnumErrorHighDefault ( const long  enumValue)

Add default error high threshold.

Parameters
enumValuelong enum value to be added to set of error high values.
void carma::monitor::MonitorPointEnum::addEnumErrorLowDefault ( const long  enumValue)

Add default error low threshold.

Parameters
enumValuelong enum value to be added to set of error low values.
void carma::monitor::MonitorPointEnum::addEnumWarnHighDefault ( const long  enumValue)

Add default warning high threshold.

Parameters
enumValuelong enum value to be added to set of warn high values.
void carma::monitor::MonitorPointEnum::addEnumWarnLowDefault ( const long  enumValue)

Add default warning low threshold.

Parameters
enumValuelong enum value to be added to set of warn low values.
virtual std::string carma::monitor::MonitorPointEnum::convertToString ( int  enumValue) const
protectedpure virtual

Convert an integer value, interpreted as an enum, into a string.

Returns
string representing the enumeration value
virtual enum MonitorPoint::VALIDITY carma::monitor::MonitorPointEnum::evaluateSampleTolerance ( const MonitorPointThreshold &  threshold,
int  enumVal 
) const
virtual

Method to return validity for a sample using the range parameters in the MonitorPointThreshold object,.

threshold

.

Parameters
thresholdMonitorPointThreshold object with the threshold range settings for this monitor point.
enumValint value of sample to be compared against range settings.
Returns
MonitorPoint::VALIDITY appropriate VALIDITY flag for sample.
virtual void carma::monitor::MonitorPointEnum::evaluateTolerance ( const MonitorPointThreshold &  threshold)
virtual

Set the validity flags for the MonitorPoint using the threshold limits stored in the input MonitorPointThreshold object.

Parameters
thresholdMonitorPointThreshold object holding user set threshold limits for this monitor point
See Also
setErrorHigh, setWarnHigh, setWarnLow, setErrorLow
getErrorHigh, getWarnHigh, getWarnLow, getErrorLow

Reimplemented from carma::monitor::MonitorPoint.

virtual AccumReportType carma::monitor::MonitorPointEnum::getAccumulatedAverage ( const AccumType accum) const
virtual

Compute average from accumulated values in accumulator object.

Parameters
accumwill accumulate values over time for computing averages.
Returns
bool computed average value.
virtual std::string carma::monitor::MonitorPointEnum::getAccumulatedAverageAsString ( const AccumType accum) const
virtual

Create and return string representation for average accumulated in accumulator object.

Parameters
accumwill accumulate values over time for computing averages.
Returns
std::string average value as string.
virtual AccumReportType carma::monitor::MonitorPointEnum::getMaxValue ( const AccumType accum) const
virtual

Returns maximum value from accumulated data in accumulator object.

Parameters
accumholds data for computing average.
Returns
int max value accumulated in the accumulator object.
See Also
carma::monitor::MonitorPointAverageT
virtual AccumReportType carma::monitor::MonitorPointEnum::getMinValue ( const AccumType accum) const
virtual

Returns minimum value from accumulated data in accumulator object.

Parameters
accumholds data for computing average.
Returns
short min value accumulated in the accumulator object.
See Also
carma::monitor::MonitorPointAverageT
int carma::monitor::MonitorPointEnum::getNumEnumerations ( ) const

Get the number of enumerations.

virtual short carma::monitor::MonitorPointEnum::getWidth ( ) const
virtual

Get the string length to use when interpreting the value to a string.

Returns
width of the string representing the monitor point value

Reimplemented from carma::monitor::MonitorPoint.

bool carma::monitor::MonitorPointEnum::isBitmask ( ) const

Is this monitor point enumeration a bitmask.

Definition at line 922 of file monitorPointSpecializations.h.

void carma::monitor::MonitorPointEnum::removeEnumErrorHighDefault ( const long  enumValue)

Remove enum value from default error low threshold.

Parameters
enumValuelong enum value to be removed from set of error low values.
void carma::monitor::MonitorPointEnum::removeEnumErrorLowDefault ( const long  enumValue)

Remove enum value from default error high threshold.

Parameters
enumValuelong enum value to be removed from set of error high values.
void carma::monitor::MonitorPointEnum::removeEnumWarnHighDefault ( const long  enumValue)

Remove enum value from default warning high threshold.

Parameters
enumValuelong enum value to be removed from set of warn high values.
void carma::monitor::MonitorPointEnum::removeEnumWarnLowDefault ( const long  enumValue)

Remove enum value from default warning low threshold.

Parameters
enumValuelong enum value to be removed from set of warn low values.
virtual void carma::monitor::MonitorPointEnum::resetAccumulator ( AccumType accum) const
virtual

Reset accumulator values from for computing averages.

Parameters
accumwill accumulate values over time for computing averages.
Returns
none
void carma::monitor::MonitorPointEnum::setNumEnumerations ( int  num)

Set the number of enumerations.

Parameters
numof enums
virtual void carma::monitor::MonitorPointEnum::updateFrameAverage ( ScratchAverages &  scratchAvgs)
virtual

Abstract method that updates the average value/validity for the frame.

Both computes and stores, based on the sample values/validities. Must be implemented by concrete class.

Implements carma::monitor::MonitorPoint.


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