#include <DC_SampleFullDataPool.h>
Inheritance diagram for DC_SampleFullDataPool:
The code for this class was automatically generated by an XSL program using as input an XML-based description of the data pool. This class fully defines the structure of the data pool: its constructor allocates memory for all internal data structures and it initializes them to reflect the data pool layout defined in the XML-based data pool descriptor file.
This data pool has the following characteristics:
ObsClock
component DC_DataItem
) attached to each data pool item. MonitoringProfile
) attached to each data pool item. RecoveryAction
) attached to each data pool item. DC_SampleFullDataPool_inc.h
) is also automatically generated that defines symbolic names to access the items in the data pool.
Definition at line 62 of file DC_SampleFullDataPool.h.
Public Member Functions | |
DC_SampleFullDataPool (void) | |
Instantiate a data pool component. | |
void | setObsClock (ObsClock *pObsClock) |
Load the OBS Clock component. | |
ObsClock * | getObsClock (void) const |
Return the OBS Clock component. | |
virtual void | setValue (TD_DataPoolId id, TD_Float newValue) |
Setter method for the value of a real-typed data pool item. | |
virtual void | setValue (TD_DataPoolId id, TD_Integer newValue) |
Setter method for the value of an integer-typed data pool item. | |
virtual TD_Float | getFloatValue (TD_DataPoolId id) |
Getter method for the value of a real-typed data pool item. | |
virtual TD_Integer | getIntegerValue (TD_DataPoolId id) |
Getter method for the value of an integer-typed data pool item. | |
virtual TD_Float * | getPointerFloatValue (TD_DataPoolId id) |
Getter method for the pointer to a real-typed data pool item. | |
virtual TD_Integer * | getPointerIntegerValue (TD_DataPoolId id) |
Getter method for the pointer to an integer-typed data pool item. | |
virtual DC_DataItem * | getDataItem (TD_DataPoolId id) |
Getter method for a data item that encapsulates a data pool item. | |
virtual TD_ObsTime | getTimeStamp (TD_DataPoolId id) |
Return the time stamp of a data pool item. | |
virtual bool | isValid (TD_DataPoolId id) |
Return the validity status of a data pool item. | |
virtual void | setValidityStatus (TD_DataPoolId id, bool newValidityStatus) |
Set the validity status of a data pool item. | |
virtual MonitoringProfile * | getMonitoringProfile (TD_DataPoolId id) |
Get the monitoring profile for a data pool item. | |
virtual void | setMonitoringProfile (TD_DataPoolId id, MonitoringProfile *pMonitoringProfile) |
Set the monitoring profile for a data pool item. | |
virtual RecoveryAction * | getRecoveryAction (TD_DataPoolId id) |
Get the recovery action for a data pool item. | |
virtual void | setRecoveryAction (TD_DataPoolId id, RecoveryAction *pRcoveryAction) |
Set the recovery action for a data pool item. | |
virtual TD_DataPoolId | firstIdentifier (void) |
Iteration method that resets the iteration and returns the lowest indentifier of the items in the data pool. | |
virtual TD_DataPoolId | nextIdentifier (void) |
Iteration method that returns the next identifier in an iteration. | |
virtual bool | isLastIdentifier (void) |
Iteration method that returns the next identifier in an iteration. | |
virtual bool | isFloat (TD_DataPoolId id) |
Method implementing the type checking service to check whether a data pool item is real-typed. | |
virtual bool | isInteger (TD_DataPoolId id) |
Method implementing the type checking service to check whether a data pool item is integer-typed. | |
virtual void | reset (void) |
Implement the data pool reset service. | |
virtual bool | isObjectConfigured (void) |
Perform a class-specific configuration check. |
|
Instantiate a data pool component.
The class identifier is set. All internal data structures are allocated and initialized. The data pool is internally implemented as a linear array. In order to avoid alignment problems, this array is forced to be aligned with an 8-byte word boundary (more specifically, it is aligned with a location that can store a value of type Definition at line 22 of file DC_SampleFullDataPool.cpp. |
|
Iteration method that resets the iteration and returns the lowest indentifier of the items in the data pool.
Reimplemented from DataPool. Definition at line 341 of file DC_SampleFullDataPool.cpp. |
|
Getter method for a data item that encapsulates a data pool item. This method implements the data item link mechanism. If the validity status of the data pool item is "not valid", then the data item returned by this method is dynamically reconfigured to point to back up value of the data pool item.
Reimplemented from DataPool. Definition at line 216 of file DC_SampleFullDataPool.cpp. |
|
Getter method for the value of a real-typed data pool item. This method implements the copy link mechanism for real-valued data. If the validity status of the data pool item is "not valid", then the back up value of the data pool item is returned.
Implements DataPool. Definition at line 147 of file DC_SampleFullDataPool.cpp. |
|
Getter method for the value of an integer-typed data pool item. This method implements the copy link mechanism for integer-valued data. If the validity status of the data pool item is "not valid", then the back up value of the data pool item is returned.
Implements DataPool. Definition at line 166 of file DC_SampleFullDataPool.cpp. |
|
Get the monitoring profile for a data pool item.
The component that is returned by this method is the component that is set loaded with method
Reimplemented from DataPool. Definition at line 278 of file DC_SampleFullDataPool.cpp. |
|
Return the OBS Clock component.
Definition at line 106 of file DC_SampleFullDataPool.cpp. |
|
Getter method for the pointer to a real-typed data pool item. This method implements the pointer link mechanism for real-typed data.
Implements DataPool. Definition at line 185 of file DC_SampleFullDataPool.cpp. |
|
Getter method for the pointer to an integer-typed data pool item. This method implements the pointer link mechanism for integer-typed data.
Implements DataPool. Definition at line 200 of file DC_SampleFullDataPool.cpp. |
|
Get the recovery action for a data pool item.
The component that is returned by this method is the component that is set loaded with method
Reimplemented from DataPool. Definition at line 309 of file DC_SampleFullDataPool.cpp. |
|
Return the time stamp of a data pool item. The time stamp of a data pool item is set by the setter method when the item value is updated. Note that it the data pool item is accessed using its pointer or its data item, then the time stamp is not updated.
Reimplemented from DataPool. Definition at line 231 of file DC_SampleFullDataPool.cpp. |
|
Method implementing the type checking service to check whether a data pool item is real-typed.
Reimplemented from DataPool. Definition at line 363 of file DC_SampleFullDataPool.cpp. |
|
Method implementing the type checking service to check whether a data pool item is integer-typed.
Reimplemented from DataPool. Definition at line 378 of file DC_SampleFullDataPool.cpp. |
|
Iteration method that returns the next identifier in an iteration.
Reimplemented from DataPool. Definition at line 357 of file DC_SampleFullDataPool.cpp. |
|
Perform a class-specific configuration check. The following checks are performed:
Reimplemented from CC_RootObject. Definition at line 393 of file DC_SampleFullDataPool.cpp. |
|
Return the validity status of a data pool item.
The value that is returned is the value that is set with method
Reimplemented from DataPool. Definition at line 246 of file DC_SampleFullDataPool.cpp. |
|
Iteration method that returns the next identifier in an iteration.
Reimplemented from DataPool. Definition at line 349 of file DC_SampleFullDataPool.cpp. |
|
Implement the data pool reset service. The validity status of all data pool item is reset to the value it had at the time the data pool component was created.
Reimplemented from DataPool. Definition at line 406 of file DC_SampleFullDataPool.cpp. |
|
Set the monitoring profile for a data pool item. If the data pool item identifier has an illegal value, then no action is taken other than generating an event of type EVT_ILLEGAL_DP_ACCESS.
Definition at line 293 of file DC_SampleFullDataPool.cpp. |
|
Load the OBS Clock component. The data pool needs access to this component in order to time-stamp new values of data pool items.
Definition at line 101 of file DC_SampleFullDataPool.cpp. |
|
Set the recovery action for a data pool item. If the data pool item identifier has an illegal value, then no action is taken other than generating an event of type EVT_ILLEGAL_DP_ACCESS.
Definition at line 324 of file DC_SampleFullDataPool.cpp. |
|
Set the validity status of a data pool item. If the data pool item identifier has an out-of-range value, then no action is taken other than generating an event of type EVT_ILLEGAL_DP_ACCESS.
Reimplemented from DataPool. Definition at line 261 of file DC_SampleFullDataPool.cpp. |
|
Setter method for the value of an integer-typed data pool item. When this method is called on a data pool item, its time stamp is automatically updated. If the validity status of the data pool item is "valid", then its back up value is also updated. If the data pool item identifier has an illegal value, then no action is taken other than generating an event of type EVT_ILLEGAL_DP_ACCESS.
Implements DataPool. Definition at line 129 of file DC_SampleFullDataPool.cpp. |
|
Setter method for the value of a real-typed data pool item. When this method is called on a data pool item, its time stamp is automatically updated. If the validity status of the data pool item is "valid", then its back up value is also updated. If the data pool item identifier has an illegal value, then no action is taken other than generating an event of type EVT_ILLEGAL_DP_ACCESS.
Implements DataPool. Definition at line 111 of file DC_SampleFullDataPool.cpp. |