Class that manages the IPQ version of SystemThresholdFrame. More...
#include <carma/monitor/SystemThresholdFrameBuffer.h>
Public Member Functions | |
| virtual void | calibrateMonitorSystem () |
| Reads latest threshold values from IPQ and sets threshold related validity flags for all monitor points in the MonitorSystem. More... | |
| SystemThresholdFrameBuffer (MonitorSystem &monitorSystem) | |
| Constructor - Order of class construction is crucial here. More... | |
| virtual | ~SystemThresholdFrameBuffer () |
| Destructor - deletes frame structure if deleteStruct flag was true when the object was constructed. More... | |
 Public Member Functions inherited from carma::monitor::SystemThresholdFrame | |
| long | getMaxNumThresholds () const |
| Returns maximum number of allocatable thresholds. More... | |
| long | getNumThresholds () const |
| Returns number of allocated thresholds. More... | |
| MonitorPointThreshold & | getThreshold (tagIDType tagID) const |
| Returns the MonitorPointThreshold object associated with the monitor point mp such that mp.getTagID() == tagID. More... | |
| SystemThresholdFrame (MonitorSystem &monitorSystem) | |
| Constructor - creates a struct using the MonitorSystem, initializes struct with the maxThresholds, sizes it correctly, so the pointers point to meaningful spaces. More... | |
| virtual | ~SystemThresholdFrame () |
| Destructor - deletes frame structure. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from carma::monitor::SystemThresholdFrame | |
| int | findThreshold (tagIDType tagID) const |
| Searches for index to threshold with tagID. More... | |
| ThresholdFrameStruct & | getThresholdFrame () const |
| Returns reference to internal ThresholdFrameStruct. More... | |
| ThresholdStruct & | getThresholdStruct (int index) const |
| Returns reference to internal ThresholdStruct. More... | |
| Static Protected Member Functions inherited from carma::monitor::SystemThresholdFrame | |
| static ThresholdFrameStruct & | fixupFramePointers (ThresholdFrameStruct &frame) |
| Initializes the pointers within the ThresholdFrameStruct to point to meaningful spaces based on the maxNumThresholds member of the structure. More... | |
| static ThresholdFrameStruct & | setThresholdFrameSize (ThresholdFrameStruct &frame, long maxThresholds) |
| Initializes size related portions of ThresholdFrameStruct. More... | |
| static size_t | sizeThresholdFrame (long maxThresholds) |
| Computes size of threshold frame required to hold. More... | |
Detailed Description
Class that manages the IPQ version of SystemThresholdFrame.
Order of construction is very important here. The IPQbuffer stores the information in the SystemThresholdFrame object in the IPQ, so the SystemThresholdFrame must be constructed before the IPQbuffer, otherwise the IPQ buffer will have nothing to store at the time of construction.
- See Also
- SystemThresholdFrame.
- carma::util::IPQbuffer.
Definition at line 39 of file SystemThresholdFrameBuffer.h.
Constructor & Destructor Documentation
|
explicit |
Constructor - Order of class construction is crucial here.
Base classes are constructed bottom up, so SystemThresholdFrame is constructed first, then IPQbuffer and, finally, the SystemThresholdBuffer class instance.
- Parameters
-
monitorSystem SystemThreshold is bound to this MonitorSystem object.
|
virtual |
Destructor - deletes frame structure if deleteStruct flag was true when the object was constructed.
Member Function Documentation
|
virtual |
Reads latest threshold values from IPQ and sets threshold related validity flags for all monitor points in the MonitorSystem.
- Returns
- none
Reimplemented from carma::monitor::SystemThresholdFrame.
The documentation for this class was generated from the following file:
- carma/monitor/SystemThresholdFrameBuffer.h
