#include <PUSTelemetryPacket.h>
Inheritance diagram for PUSTelemetryPacket:
A PUS telemetry packet class encapsulate a packet of telemetry data that is compliant with the Packet Utilization Stadard (PUS). PUS telemetry packet classes are organized as telemetry packets in the sense that this class extends class TelemetryPacket
. Class TelemetryPacket
defines a data acquisition service to acquire a stream of telemetry bytes. From the point of view of the PUSTelemetryPacket
class, this stream of bytes represent the source data part of the PUS packet encapsulated by the class. The mapping between the attributes defined by the TelemetryPacket
superclass and the attributes mandated by the PUS is as follows:<ul> The packet ID PUS attribute has a fixed value for all telemetry packet originating from the same application process and it is therefore implemented as a static attribute. The service type PUS attribute is mapped to the telemetry packet type attribute of the TelemetryPacket
class. The service subtype PUS attribute is mapped to the telemetry packet subtype attribute of the TelemetryPacket
class. The destination PUS attribute is mapped to the telemetry packet destination attribute of the TelemetryPacket
class. The time PUS attribute is mapped to the telemetry packet time tag attribute of the TelemetryPacket
class. Since most telemetry packets in an application can be expected to have the same destination, this class also defines a static default destination attribute.
Definition at line 49 of file PUSTelemetryPacket.h.
Public Member Functions | |
PUSTelemetryPacket (void) | |
Instantiate a PUS telemetry packet component. | |
virtual void | setType (TD_TelemetryType tmType) |
Setter method for the telemetry packet type. | |
virtual void | setSubType (TD_TelemetrySubType tmSubType) |
Setter method for the telemetry packet sub-type. | |
virtual void | setDestination (TD_TelemetryDestination tmDest) |
Setter method for the telemetry packet destination. | |
virtual TD_TelemetryType | getType (void) const |
Getter method for the telemetry type. | |
virtual TD_TelemetrySubType | getSubType (void) const |
Getter method for the telemetry sub-type. | |
virtual TD_ObsTime | getTimeTag (void) const |
Getter method for the telemetry packet time tag. | |
virtual void | setTimeTag (TD_ObsTime timeTag) |
Setter method for the telemetry packet time tag. | |
virtual TD_TelemetryDestination | getDestination (void) const |
Getter method for the telemetry packet destination. | |
virtual bool | isObjectConfigured (void) |
Perform a class-specific configuration check on the telemetry packet: verify that the type, the sub type, the destination, the time tag, and the packet identifier have a legal value. | |
Static Public Member Functions | |
void | setApplicationId (TD_APID apid) |
Setter method for the application identifier (APID). | |
TD_PUSPacketId | getPacketId (void) |
Getter method for the telemetry packet identifier. | |
TD_TelemetryDestination | getDefaultDestination (void) |
Getter method for the telemetry packet default destination. | |
void | setDefaultDestination (TD_TelemetryDestination defDest) |
Setter method for the telemetry packet default destination. | |
void | setObsClock (ObsClock *pObsClock) |
Load the OBS Clock component. | |
ObsClock * | getObsClock (void) |
Return the OBS Clock component. |
|
Instantiate a PUS telemetry packet component. The telemetry attributes are set as follows:
Definition at line 22 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry packet default destination.
Definition at line 44 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry packet destination.
Reimplemented from TelemetryPacket. Definition at line 79 of file PUSTelemetryPacket.cpp. |
|
Return the OBS Clock component.
Definition at line 89 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry packet identifier. The telemetry packet identifier is assumed to be fixed for all telemetry packets in the same application process. According to the PUS, the packet identifier consists of the following four fields:
Definition at line 29 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry sub-type.
Reimplemented from TelemetryPacket. Definition at line 59 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry packet time tag.
Reimplemented from TelemetryPacket. Definition at line 69 of file PUSTelemetryPacket.cpp. |
|
Getter method for the telemetry type.
Reimplemented from TelemetryPacket. Definition at line 49 of file PUSTelemetryPacket.cpp. |
|
Perform a class-specific configuration check on the telemetry packet: verify that the type, the sub type, the destination, the time tag, and the packet identifier have a legal value.
Reimplemented from CC_RootObject. Reimplemented in DC_PUSDataReportingPacket, and PUSMemoryDump. Definition at line 99 of file PUSTelemetryPacket.cpp. |
|
Setter method for the application identifier (APID). The APID is used to construct the telemetry packet identifier. The APID is placed in the 11 least-significant bits of the PUS packet identifier. A pseudo-code implementation for this method is as follows: packetId = 2**11; // set the fixed part of the packet ID packetId = packetId + apid; // set the APID part of the packet IDThe APID should be smaller than 2**11.
Definition at line 33 of file PUSTelemetryPacket.cpp. |
|
Setter method for the telemetry packet default destination.
Definition at line 39 of file PUSTelemetryPacket.cpp. |
|
Setter method for the telemetry packet destination.
Reimplemented from TelemetryPacket. Definition at line 84 of file PUSTelemetryPacket.cpp. |
|
Load the OBS Clock component. Telemetry packets may need access to this component in order to time-stamp the telemetry data as they are collected.
Definition at line 94 of file PUSTelemetryPacket.cpp. |
|
Setter method for the telemetry packet sub-type.
Reimplemented from TelemetryPacket. Definition at line 64 of file PUSTelemetryPacket.cpp. |
|
Setter method for the telemetry packet time tag.
Reimplemented from TelemetryPacket. Definition at line 74 of file PUSTelemetryPacket.cpp. |
|
Setter method for the telemetry packet type.
Reimplemented from TelemetryPacket. Definition at line 54 of file PUSTelemetryPacket.cpp. |