DC_SampleMonitoredDataPool Class Reference

#include <DC_SampleMonitoredDataPool.h>

Inheritance diagram for DC_SampleMonitoredDataPool:

List of all members.

Detailed Description

Sample data pool with full functionality..

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:

Default implementation of time stamp attribute as inherited from base class.
Low level of robustness to use of illegal identifier values in method calls: legality of the identifier value is only checked in assertions
Validity status flag attached to each data pool item.
Back-up value attached to each data pool item. When the validity status of the data pool item is equal to "valid", then the back-up value is kept identical to the primary value. When the validity status of the data pool item changes from "valid" to "not valid", then the primary value is no longer updated and the getter method and getDataItem method for the data pool item will return the back-up value. Note that the back-up mechanism is only effective for clients that link to the data pool items through the copy link or the data item link mechanism. It is not effective for clients that use the pointer link mechanism.
Data item (instance of class DC_DataItem) attached to each data pool item.
Monitoring profile (instance of class MonitoringProfile) attached to each data pool item.
Default implementation of recovery action attribute as inherited from base class.
Default implementation of type checking service as inherited from base class.

Note that an include file (DC_SampleMonitoredDataPool_inc.h) is also automatically generated that defines symbolic names to access the items in the data pool.

Author:: Automatically Generated

Version:: 1.0

Definition at line 58 of file DC_SampleMonitoredDataPool.h.

Public Member Functions

DC_SampleMonitoredDataPool (void)

Instantiate a data pool 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 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 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 void reset (void)

Implement the data pool reset service.

virtual bool isObjectConfigured (void)

Perform a class-specific configuration check.

Constructor & Destructor Documentation

DC_SampleMonitoredDataPool::DC_SampleMonitoredDataPool ( void )

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 double). The validity status of all data pool items is initialized to "valid".
Definition at line 22 of file DC_SampleMonitoredDataPool.cpp.

Member Function Documentation

TD_DataPoolId DC_SampleMonitoredDataPool::firstIdentifier ( void ) [virtual]

Iteration method that resets the iteration and returns the lowest indentifier of the items in the data pool.

See also:
DataPool::firstIdentifier

Returns:
the identifier of the first data pool item in the iteration

Reimplemented from DataPool.
Definition at line 191 of file DC_SampleMonitoredDataPool.cpp.

DC_DataItem * DC_SampleMonitoredDataPool::getDataItem ( TD_DataPoolId id ) [virtual]

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.
See also:
DC_DataItem

Parameters:

id the data identifier of the data pool item to be read

Returns:
the DC_DataItem item encapsulating the data pool item with identifier id

Reimplemented from DataPool.
Definition at line 154 of file DC_SampleMonitoredDataPool.cpp.

TD_Float DC_SampleMonitoredDataPool::getFloatValue ( TD_DataPoolId id ) [virtual]

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.
Parameters:

id the data identifier of the data pool item to be read

Returns:
the value of the data with identifier id

Implements DataPool.
Definition at line 125 of file DC_SampleMonitoredDataPool.cpp.

TD_Integer DC_SampleMonitoredDataPool::getIntegerValue ( TD_DataPoolId id ) [virtual]

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.
Parameters:

id the data identifier of the data pool item to be read

Returns:
the value of the data with identifier id

Implements DataPool.
Definition at line 134 of file DC_SampleMonitoredDataPool.cpp.

MonitoringProfile * DC_SampleMonitoredDataPool::getMonitoringProfile ( TD_DataPoolId id ) [virtual]

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 setMonitoringProfile.
See also:
setMonitoringProfile

Parameters:

id the identifier of the data pool item

Returns:
the monitoring profile

Reimplemented from DataPool.
Definition at line 179 of file DC_SampleMonitoredDataPool.cpp.

TD_Float * DC_SampleMonitoredDataPool::getPointerFloatValue ( TD_DataPoolId id ) [virtual]

Getter method for the pointer to a real-typed data pool item.
This method implements the pointer link mechanism for real-typed data.
Parameters:

id the data identifier of the data pool item to be read

Returns:
the pointer to the data with identifier id

Implements DataPool.
Definition at line 143 of file DC_SampleMonitoredDataPool.cpp.

TD_Integer * DC_SampleMonitoredDataPool::getPointerIntegerValue ( TD_DataPoolId id ) [virtual]

Getter method for the pointer to an integer-typed data pool item.
This method implements the pointer link mechanism for integer-typed data.
Parameters:

id the data identifier of the data pool item to be read

Returns:
the pointer to the data with identifier id

Implements DataPool.
Definition at line 148 of file DC_SampleMonitoredDataPool.cpp.

bool DC_SampleMonitoredDataPool::isLastIdentifier ( void ) [virtual]

Iteration method that returns the next identifier in an iteration.

See also:
DataPool::firstIdentifier

Returns:
true if the iteration has completed, false otherwise

Reimplemented from DataPool.
Definition at line 207 of file DC_SampleMonitoredDataPool.cpp.

bool DC_SampleMonitoredDataPool::isObjectConfigured ( void ) [virtual]

Perform a class-specific configuration check.
The following checks are performed:

All monitoring profiles have been loaded

Returns:
true if the data pool object is configured, false otherwise

Reimplemented from CC_RootObject.
Definition at line 213 of file DC_SampleMonitoredDataPool.cpp.

bool DC_SampleMonitoredDataPool::isValid ( TD_DataPoolId id ) [virtual]

Return the validity status of a data pool item.
The value that is returned is the value that is set with method setValidityStatus.
See also:
setValidityStatus

Parameters:

id the data identifier of the data pool item

Returns:
true if the data pool item is valid, false otherwise

Reimplemented from DataPool.
Definition at line 159 of file DC_SampleMonitoredDataPool.cpp.

TD_DataPoolId DC_SampleMonitoredDataPool::nextIdentifier ( void ) [virtual]

Iteration method that returns the next identifier in an iteration.

See also:
DataPool::firstIdentifier

Returns:
the identifier of the next data pool item in the iteration

Reimplemented from DataPool.
Definition at line 199 of file DC_SampleMonitoredDataPool.cpp.

void DC_SampleMonitoredDataPool::reset ( void ) [virtual]

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.
See also:
isValid

Reimplemented from DataPool.
Definition at line 226 of file DC_SampleMonitoredDataPool.cpp.

void DC_SampleMonitoredDataPool::setMonitoringProfile ( TD_DataPoolId id,

MonitoringProfile * pMonitoringProfile

) [virtual]

Set the monitoring profile for a data pool item.

See also:
getMonitoringProfile

Parameters:

id the identifier of the data pool item

pMonitoringProfile the monitoring profile

Definition at line 184 of file DC_SampleMonitoredDataPool.cpp.

void DC_SampleMonitoredDataPool::setValidityStatus ( TD_DataPoolId id,

bool newValidityStatus

) [virtual]

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.
Parameters:

id the data identifier of the data pool item

newValidityStatus the new validity status

Reimplemented from DataPool.
Definition at line 164 of file DC_SampleMonitoredDataPool.cpp.

void DC_SampleMonitoredDataPool::setValue ( TD_DataPoolId id,

TD_Integer newValue

) [virtual]

Setter method for the value of an integer-typed data pool item.
If the validity status of the data pool item is "valid", then its back up value is also updated.
Parameters:

id the data identifier of the data pool item to be set

newValue the new value to be set

Implements DataPool.
Definition at line 118 of file DC_SampleMonitoredDataPool.cpp.

void DC_SampleMonitoredDataPool::setValue ( TD_DataPoolId id,

TD_Float newValue

) [virtual]

Setter method for the value of a real-typed data pool item.
If the validity status of the data pool item is "valid", then its back up value is also updated.
Parameters:

id the data identifier of the data pool item to be set

newValue the new value to be set

Implements DataPool.
Definition at line 111 of file DC_SampleMonitoredDataPool.cpp.

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


Public Member Functions
	DC_SampleMonitoredDataPool (void)
	Instantiate a data pool 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 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 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 void	reset (void)
	Implement the data pool reset service.
virtual bool	isObjectConfigured (void)
	Perform a class-specific configuration check.