Fw::FilePacket::DataPacket Class Reference

The type of a data packet. More...

#include <Fw/FilePacket/FilePacket.hpp>

Public Types
enum	{ HEADERSIZE }
	header size More...

Public Member Functions
void	initialize (const U32 sequenceIndex, const U32 byteOffset, const U16 dataSize, const U8 *const data)
	Initialize a data packet.
U32	bufferSize () const
	Compute the buffer size needed to hold this DataPacket.
SerializeStatus	toBuffer (Buffer &buffer) const
	Convert this DataPacket to a Buffer.
const FilePacket::Header &	asHeader () const
	Get this as a Header.
U32	getByteOffset () const
	Get the byte offset.
U32	getDataSize () const
	Get the data size.
const U8 *	getData () const
	Get the data.

Friends
union	FilePacket

Detailed Description

The type of a data packet.

Definition at line 197 of file FilePacket.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

header size

Enumerator
HEADERSIZE

Definition at line 218 of file FilePacket.hpp.

Member Function Documentation

asHeader()

const FilePacket::Header & Fw::FilePacket::DataPacket::asHeader ( ) const

inline

Get this as a Header.

Definition at line 237 of file FilePacket.hpp.

bufferSize()

U32 Fw::FilePacket::DataPacket::bufferSize

(

)

const

Compute the buffer size needed to hold this DataPacket.

Definition at line 32 of file DataPacket.cpp.

getByteOffset()

U32 Fw::FilePacket::DataPacket::getByteOffset ( ) const

inline

Get the byte offset.

Definition at line 242 of file FilePacket.hpp.

getData()

const U8 * Fw::FilePacket::DataPacket::getData ( ) const

inline

Get the data.

Definition at line 252 of file FilePacket.hpp.

getDataSize()

U32 Fw::FilePacket::DataPacket::getDataSize ( ) const

inline

Get the data size.

Definition at line 247 of file FilePacket.hpp.

initialize()

void Fw::FilePacket::DataPacket::initialize	(	const U32	sequenceIndex,
		const U32	byteOffset,
		const U16	dataSize,
		const U8 *const	data )

Initialize a data packet.

Parameters

sequenceIndex	The sequence index
byteOffset	The byte offset
dataSize	The data size
data	The file data

Definition at line 18 of file DataPacket.cpp.

toBuffer()

SerializeStatus Fw::FilePacket::DataPacket::toBuffer

(

Buffer &

buffer

)

const

Convert this DataPacket to a Buffer.

Definition at line 42 of file DataPacket.cpp.

Friends And Related Symbol Documentation

FilePacket

friend union FilePacket

friend

Definition at line 199 of file FilePacket.hpp.

---

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

• Fw/FilePacket/FilePacket.hpp
• Fw/FilePacket/DataPacket.cpp