Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

DC_SampleFullDataPool Class Reference

#include <DC_SampleFullDataPool.h>

Inheritance diagram for DC_SampleFullDataPool:

DataPool CC_RootObject 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:

Note that an include file (DC_SampleFullDataPool_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 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.

ObsClockgetObsClock (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_FloatgetPointerFloatValue (TD_DataPoolId id)
 Getter method for the pointer to a real-typed data pool item.

virtual TD_IntegergetPointerIntegerValue (TD_DataPoolId id)
 Getter method for the pointer to an integer-typed data pool item.

virtual DC_DataItemgetDataItem (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 MonitoringProfilegetMonitoringProfile (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 RecoveryActiongetRecoveryAction (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.


Constructor & Destructor Documentation

DC_SampleFullDataPool::DC_SampleFullDataPool 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 time stamp of all data pool items is initialized to zero. The validity status of all data pool items is initialized to "valid". The plug-in OBS Clock component is initialized to an illegal value to signify that the data pool component is not yet configured.

Definition at line 22 of file DC_SampleFullDataPool.cpp.


Member Function Documentation

TD_DataPoolId DC_SampleFullDataPool::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 341 of file DC_SampleFullDataPool.cpp.

DC_DataItem * DC_SampleFullDataPool::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 216 of file DC_SampleFullDataPool.cpp.

TD_Float DC_SampleFullDataPool::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 147 of file DC_SampleFullDataPool.cpp.

TD_Integer DC_SampleFullDataPool::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 166 of file DC_SampleFullDataPool.cpp.

MonitoringProfile * DC_SampleFullDataPool::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 278 of file DC_SampleFullDataPool.cpp.

ObsClock * DC_SampleFullDataPool::getObsClock void   )  const
 

Return the OBS Clock component.

See also:
setObsClock
Returns:
the OBS Clock component.

Definition at line 106 of file DC_SampleFullDataPool.cpp.

TD_Float * DC_SampleFullDataPool::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 185 of file DC_SampleFullDataPool.cpp.

TD_Integer * DC_SampleFullDataPool::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 200 of file DC_SampleFullDataPool.cpp.

RecoveryAction * DC_SampleFullDataPool::getRecoveryAction TD_DataPoolId  id  )  [virtual]
 

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 setRecoveryAction.

See also:
setRecoveryAction
Parameters:
id the identifier of the data pool item
Returns:
the monitoring profile

Reimplemented from DataPool.

Definition at line 309 of file DC_SampleFullDataPool.cpp.

TD_ObsTime DC_SampleFullDataPool::getTimeStamp TD_DataPoolId  id  )  [virtual]
 

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.

Parameters:
id the data identifier of the data whose time stamp is sought
Returns:
the time stamp of the data with identifier id

Reimplemented from DataPool.

Definition at line 231 of file DC_SampleFullDataPool.cpp.

bool DC_SampleFullDataPool::isFloat TD_DataPoolId  id  )  [virtual]
 

Method implementing the type checking service to check whether a data pool item is real-typed.

See also:
DataPool::isFloat

id the identifier of the data pool item

Returns:
true if the id is the identifier of a real-valued data item, false otherwise

Reimplemented from DataPool.

Definition at line 363 of file DC_SampleFullDataPool.cpp.

bool DC_SampleFullDataPool::isInteger TD_DataPoolId  id  )  [virtual]
 

Method implementing the type checking service to check whether a data pool item is integer-typed.

See also:
DataPool::isInteger

id the identifier of the data pool item

Returns:
true if the id is the identifier of a real-valued data item, false otherwise

Reimplemented from DataPool.

Definition at line 378 of file DC_SampleFullDataPool.cpp.

bool DC_SampleFullDataPool::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 357 of file DC_SampleFullDataPool.cpp.

bool DC_SampleFullDataPool::isObjectConfigured void   )  [virtual]
 

Perform a class-specific configuration check.

The following checks are performed:

  • All monitoring profiles have been loaded
  • All recovery actions have been loaded
  • The OBS Clock plug-in component has been loaded
Returns:
true if the data pool object is configured, false otherwise

Reimplemented from CC_RootObject.

Definition at line 393 of file DC_SampleFullDataPool.cpp.

bool DC_SampleFullDataPool::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 246 of file DC_SampleFullDataPool.cpp.

TD_DataPoolId DC_SampleFullDataPool::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 349 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::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 406 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::setMonitoringProfile TD_DataPoolId  id,
MonitoringProfile pMonitoringProfile
[virtual]
 

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.

See also:
getMonitoringProfile
Parameters:
id the identifier of the data pool item
pMonitoringProfile the monitoring profile

Definition at line 293 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::setObsClock ObsClock pObsClock  ) 
 

Load the OBS Clock component.

The data pool needs access to this component in order to time-stamp new values of data pool items.

Parameters:
pObsClock the OBS Clock component.

Definition at line 101 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::setRecoveryAction TD_DataPoolId  id,
RecoveryAction pRcoveryAction
[virtual]
 

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.

See also:
getRecoveryAction
Parameters:
id the identifier of the data pool item
pRcoveryAction the recovery action

Definition at line 324 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::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 261 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::setValue TD_DataPoolId  id,
TD_Integer  newValue
[virtual]
 

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.

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 129 of file DC_SampleFullDataPool.cpp.

void DC_SampleFullDataPool::setValue TD_DataPoolId  id,
TD_Float  newValue
[virtual]
 

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.

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_SampleFullDataPool.cpp.


The documentation for this class was generated from the following files:
Copyright 2003 P&P Software GmbH - All Rights Reserved