DC_DummyPUSTelecommand Class Reference

#include <DC_DummyPUSTelecommand.h>

Inheritance diagram for DC_DummyPUSTelecommand:

List of all members.

Detailed Description

Dummy PUS telecommand that increments a counter every time it is executed.

This telecommand is useful for testing purposes. The values of the telecommand packet attributes are initialized to:

The telecommand identifier is set to TEST_TC_ID
The telecommand type is set to TEST_TC_TYPE
The telecommand subtype is set to TEST_TC_SUBTYPE
The telecommand source is set to TEST_TC_SOURCE
The telecommand acknowledge level is set to indicate "no acknoledge is required"

The constants are defined in file TestConstants.h. Note that the APID of the process receiving the telecommands does not need to be set because it is a static field that should be set during the test set up process.

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

Version:: 1.0

Definition at line 35 of file DC_DummyPUSTelecommand.h.

Public Member Functions

DC_DummyPUSTelecommand (void)

Instantiate a dummy PUS telecommand.

unsigned int getExecutionCounter (void)

Getter method for the execution counter.

Protected Member Functions

virtual TD_ActionOutcome doAction (void)

Increment the execution counter by one and return a code of "action successful".

Constructor & Destructor Documentation

DC_DummyPUSTelecommand::DC_DummyPUSTelecommand ( void )

Instantiate a dummy PUS telecommand.
The execution counter is set to zero. The class identifier is set. The values of the telecommand packet attributes are initialized as described in the class comment.
Definition at line 16 of file DC_DummyPUSTelecommand.cpp.

Member Function Documentation

TD_ActionOutcome DC_DummyPUSTelecommand::doAction ( void ) [protected, virtual]

Increment the execution counter by one and return a code of "action successful".

See also:
PunctualAction::execute

Returns:
always returns a "telecommand successfully executed" code

Implements PunctualAction.
Definition at line 30 of file DC_DummyPUSTelecommand.cpp.

unsigned int DC_DummyPUSTelecommand::getExecutionCounter ( void )

Getter method for the execution counter.

Returns:
the execution counter

Definition at line 26 of file DC_DummyPUSTelecommand.cpp.

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


Public Member Functions
	DC_DummyPUSTelecommand (void)
	Instantiate a dummy PUS telecommand.
unsigned int	getExecutionCounter (void)
	Getter method for the execution counter.
Protected Member Functions
virtual TD_ActionOutcome	doAction (void)
	Increment the execution counter by one and return a code of "action successful".