Fw::FilePacket::StartPacket Struct Reference

The type of a start packet. More...

#include <Fw/FilePacket/FilePacket.hpp>

Public Member Functions
void	initialize (const U32 fileSize, const char *const sourcePath, const char *const destinationPath)
	Initialize a StartPacket with sequence number 0.
U32	bufferSize () const
	Compute the buffer size needed to hold this StartPacket.
SerializeStatus	toBuffer (Buffer &buffer) const
	Convert this StartPacket to a Buffer.
const PathName &	getDestinationPath () const
	Get the destination path.
const PathName &	getSourcePath () const
	Get the source path.
U32	getFileSize () const
	Get the file size.

Friends
union	FilePacket

Detailed Description

The type of a start packet.

Definition at line 139 of file FilePacket.hpp.

Member Function Documentation

bufferSize()

U32 Fw::FilePacket::StartPacket::bufferSize

(

)

const

Compute the buffer size needed to hold this StartPacket.

Definition at line 31 of file StartPacket.cpp.

getDestinationPath()

const PathName & Fw::FilePacket::StartPacket::getDestinationPath ( ) const

inline

Get the destination path.

Definition at line 173 of file FilePacket.hpp.

getFileSize()

U32 Fw::FilePacket::StartPacket::getFileSize ( ) const

inline

Get the file size.

Definition at line 183 of file FilePacket.hpp.

getSourcePath()

const PathName & Fw::FilePacket::StartPacket::getSourcePath ( ) const

inline

Get the source path.

Definition at line 178 of file FilePacket.hpp.

initialize()

void Fw::FilePacket::StartPacket::initialize	(	const U32	fileSize,
		const char *const	sourcePath,
		const char *const	destinationPath
	)

Initialize a StartPacket with sequence number 0.

Parameters

fileSize	The file size
sourcePath	The source path
destinationPath	The destination path

Definition at line 18 of file StartPacket.cpp.

toBuffer()

SerializeStatus Fw::FilePacket::StartPacket::toBuffer

(

Buffer &

buffer

)

const

Convert this StartPacket to a Buffer.

Definition at line 41 of file StartPacket.cpp.

Friends And Related Symbol Documentation

FilePacket

friend union FilePacket

friend

Definition at line 141 of file FilePacket.hpp.

---

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

• Fw/FilePacket/FilePacket.hpp
• Fw/FilePacket/StartPacket.cpp