DC_PUSDumpMemoryAbsolute Class Reference

#include <DC_PUSDumpMemoryAbsolute.h>

Inheritance diagram for DC_PUSDumpMemoryAbsolute:

List of all members.

Detailed Description

PUS telecommand to set up a memory dump with absolute addresses.

This class encapsulates the PUS service type 6, subtype 5. This class adds to its base class the implementation of the execution action. Execution of this telecommand consists in retrieving a free telemetry packet of type DC_PUSMemoryDumpAbsolute from the telemetry packet factory, configuring it with the application data and sending it to the telemetry manager for immediate dispatch. The telemetry manager is loaded as a plug-in component at configuration time. Execution can have two outcomes. The telecommand can have a successful outcome (the return value of doAction is ACTION_SUCCESS) or it can fail for the following reasons:

No free packet could be found in the telemetry packet factory (the return value of doAction is PACKET_NOT_FOUND)
The packet could not be loaded in the telemetry manager (the return value of doAction is TM_MAN_QUEUE_FULL)
The internal structure of the application data was found to be inconsistent (the return value of doAction is APP_DATA_INCONSISTENT)

. No event reports are generated in case of failure as it is assumed that this is done by the calling client.

See also:: DC_PUSMemoryDumpOffset

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

Version:: 1.0

Definition at line 47 of file DC_PUSDumpMemoryAbsolute.h.

Public Member Functions

DC_PUSDumpMemoryAbsolute (void)

Instantiate a PUS memory dump with absolute addresses telecommand.

Protected Member Functions

virtual TD_ActionOutcome doAction (void)

Use the application data to configure and load a memory dump telemetry packet with base plus offset.

Constructor & Destructor Documentation

DC_PUSDumpMemoryAbsolute::DC_PUSDumpMemoryAbsolute ( void )

Instantiate a PUS memory dump with absolute addresses telecommand.
The class identifier is set. The telecommand subtype attribute is set to PUS_ST_TC_DMP_ABS.
Definition at line 23 of file DC_PUSDumpMemoryAbsolute.cpp.

Member Function Documentation

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

Use the application data to configure and load a memory dump telemetry packet with base plus offset.
This method queries the dynamic telemetry packet factory for a new memory dump packet. If it obtains it, it interprets the application data and configures the memory dump packet. The following operations are performed on the memory dump packet:<ul> The number of blocks is defined If a memory dump with base plus offset is required, the base address is set Each memory block is configured with its start address and length After being configured, the telemetry packet is loaded in the immediate dispatch queue of the telemetry manager. This method can return a failure code. See the class comment for details.
See also:
PunctualAction::execute

Returns:
action outcome code (see class comment)

Implements PunctualAction.
Definition at line 28 of file DC_PUSDumpMemoryAbsolute.cpp.

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


Public Member Functions
	DC_PUSDumpMemoryAbsolute (void)
	Instantiate a PUS memory dump with absolute addresses telecommand.
Protected Member Functions
virtual TD_ActionOutcome	doAction (void)
	Use the application data to configure and load a memory dump telemetry packet with base plus offset.