Fw::TlmPacket Class Reference

#include <Fw/Tlm/TlmPacket.hpp>

Inheritance diagram for Fw::TlmPacket:

Public Member Functions
	TlmPacket ()
	Constructor. More...
virtual	~TlmPacket ()
	Destructor. More...
SerializeStatus	serialize (SerializeBufferBase &buffer) const
	Serialize the packet before sending. For use internally in software. To send to the ground, use getBuffer() below. More...
SerializeStatus	deserialize (SerializeBufferBase &buffer)
	Deserialize the packet. For use internally in software. To extract channels, use setBuffer() and extractValue() below. This is NOT typically used. More...
SerializeStatus	addValue (FwChanIdType id, Time &timeTag, TlmBuffer &buffer)
	Add telemetry value to buffer. More...
SerializeStatus	extractValue (FwChanIdType &id, Time &timeTag, TlmBuffer &buffer, NATIVE_UINT_TYPE bufferSize)
SerializeStatus	resetPktSer ()
	Reset serialization of values. This should be done when starting to accumulate a new set of values. More...
SerializeStatus	resetPktDeser ()
	Reset deserialization. This should be done before extracting values. More...
Fw::ComBuffer &	getBuffer ()
	get buffer to send to the ground More...
void	setBuffer (Fw::ComBuffer &buffer)
	set the internal buffer for deserializing values More...
NATIVE_UINT_TYPE	getNumEntries ()
	get the number of packets added via addValue() More...
Public Member Functions inherited from Fw::ComPacket
	ComPacket ()
virtual	~ComPacket ()

Additional Inherited Members
Public Types inherited from Fw::ComPacket
enum	ComPacketType {   FW_PACKET_COMMAND , FW_PACKET_TELEM , FW_PACKET_LOG , FW_PACKET_FILE ,   FW_PACKET_PACKETIZED_TLM , FW_PACKET_DP , FW_PACKET_IDLE , FW_PACKET_UNKNOWN = 0xFF }
Public Types inherited from Fw::Serializable
using	SizeType = NATIVE_UINT_TYPE
Protected Member Functions inherited from Fw::ComPacket
SerializeStatus	serializeBase (SerializeBufferBase &buffer) const
SerializeStatus	deserializeBase (SerializeBufferBase &buffer)
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	destructor More...
Protected Attributes inherited from Fw::ComPacket
ComPacketType	m_type

Detailed Description

Definition at line 18 of file TlmPacket.hpp.

Constructor & Destructor Documentation

TlmPacket()

Fw::TlmPacket::TlmPacket

(

)

Constructor.

Definition at line 13 of file TlmPacket.cpp.

~TlmPacket()

Fw::TlmPacket::~TlmPacket ( )

virtual

Destructor.

Definition at line 18 of file TlmPacket.cpp.

Member Function Documentation

addValue()

SerializeStatus Fw::TlmPacket::addValue	(	FwChanIdType	id,
		Time &	timeTag,
		TlmBuffer &	buffer
	)

Add telemetry value to buffer.

Definition at line 64 of file TlmPacket.cpp.

deserialize()

SerializeStatus Fw::TlmPacket::deserialize ( SerializeBufferBase &  buffer )

virtual

Deserialize the packet. For use internally in software. To extract channels, use setBuffer() and extractValue() below. This is NOT typically used.

Implements Fw::Serializable.

Definition at line 142 of file TlmPacket.cpp.

extractValue()

SerializeStatus Fw::TlmPacket::extractValue	(	FwChanIdType &	id,
		Time &	timeTag,
		TlmBuffer &	buffer,
		NATIVE_UINT_TYPE	bufferSize
	)

extract telemetry value - since there are potentially multiple channel values in the packet, the size of the entry must be known

Definition at line 100 of file TlmPacket.cpp.

getBuffer()

Fw::ComBuffer & Fw::TlmPacket::getBuffer

(

)

get buffer to send to the ground

Definition at line 56 of file TlmPacket.cpp.

getNumEntries()

NATIVE_UINT_TYPE Fw::TlmPacket::getNumEntries

(

)

get the number of packets added via addValue()

Definition at line 52 of file TlmPacket.cpp.

resetPktDeser()

SerializeStatus Fw::TlmPacket::resetPktDeser

(

)

Reset deserialization. This should be done before extracting values.

Definition at line 34 of file TlmPacket.cpp.

resetPktSer()

SerializeStatus Fw::TlmPacket::resetPktSer

(

)

Reset serialization of values. This should be done when starting to accumulate a new set of values.

Definition at line 21 of file TlmPacket.cpp.

serialize()

SerializeStatus Fw::TlmPacket::serialize ( SerializeBufferBase &  buffer ) const

virtual

Serialize the packet before sending. For use internally in software. To send to the ground, use getBuffer() below.

serialize contents

Implements Fw::Serializable.

Definition at line 132 of file TlmPacket.cpp.

setBuffer()

void Fw::TlmPacket::setBuffer

(

Fw::ComBuffer &

buffer

)

set the internal buffer for deserializing values

Definition at line 60 of file TlmPacket.cpp.

---

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

• Fw/Tlm/TlmPacket.hpp
• Fw/Tlm/TlmPacket.cpp