DC_DataItem16TmWord Class Reference

#include <DC_DataItem16TmWord.h>

Inheritance diagram for DC_DataItem16TmWord:

List of all members.

Detailed Description

Telemetry item encapsulating a 16-bit integer accessed through a raw data item.

The raw data item is loaded as a configuration parameter.

See also:: DC_RawDataItem

Author:: Alessandro Pasetti (P&P Software GmbH)

Version:: 1.0

Definition at line 25 of file DC_DataItem16TmWord.h.

Public Member Functions

DC_DataItem16TmWord (void)

Instantiate the telemetry packet component.

virtual void update (void)

Implement the data update service.

void setDataItem (DC_RawDataItem *pDataItem)

Load the data item that is the source of the telemetry data for this telemetry packet.

virtual bool isObjectConfigured (void)

Perform a class-specific configuration check on a DC_DataItem16TmWord: verify that the data item has been loaded.

Constructor & Destructor Documentation

DC_DataItem16TmWord::DC_DataItem16TmWord ( void )

Instantiate the telemetry packet component.
This constructor initializes the size of the internal telemetry buffer of the superclass to 2 and sets the initial value of the telemetry buffer to 0. A pseudo-code implementation for this constructor is as follows:
setNumberOfBytes(2); setUnsignedShort(0,0);

Definition at line 17 of file DC_DataItem16TmWord.cpp.

Member Function Documentation

bool DC_DataItem16TmWord::isObjectConfigured ( void ) [virtual]

Perform a class-specific configuration check on a DC_DataItem16TmWord: verify that the data item has been loaded.

Returns:
true if the object is configured, false otherwise.

Reimplemented from StructuredTelemetryPacket.
Definition at line 33 of file DC_DataItem16TmWord.cpp.

void DC_DataItem16TmWord::setDataItem ( DC_RawDataItem * pDataItem )

Load the data item that is the source of the telemetry data for this telemetry packet.
The data item is assumed to encapsulate a 16-bit value.
Parameters:

pDataItem the data item acting as source of telemetry data

Definition at line 29 of file DC_DataItem16TmWord.cpp.

void DC_DataItem16TmWord::update ( void ) [virtual]

Implement the data update service.
The internal telemetry buffer is loaded with the value of the data item. A pseudo-code implementation for this method is as follows:
tmWord = . . .; // retrieve the 16-bit value of the data item setUnsignedShort(0,tmWord);

Implements StructuredTelemetryPacket.
Definition at line 24 of file DC_DataItem16TmWord.cpp.

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


Public Member Functions
	DC_DataItem16TmWord (void)
	Instantiate the telemetry packet component.
virtual void	update (void)
	Implement the data update service.
void	setDataItem (DC_RawDataItem *pDataItem)
	Load the data item that is the source of the telemetry data for this telemetry packet.
virtual bool	isObjectConfigured (void)
	Perform a class-specific configuration check on a `DC_DataItem16TmWord`: verify that the data item has been loaded.