Svc::FprimeProtocol::FrameHeader Class Reference

Describes the frame header format for the F Prime communications protocol. More...

#include <Svc/FprimeProtocol/FrameHeaderSerializableAc.hpp>

Inheritance diagram for Svc::FprimeProtocol::FrameHeader:

Public Types
enum	{ SERIALIZED_SIZE }
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	FrameHeader ()
	Constructor (default value) More...
	FrameHeader (Svc::FprimeProtocol::TokenType startWord, Svc::FprimeProtocol::TokenType lengthField)
	Member constructor. More...
	FrameHeader (const FrameHeader &obj)
	Copy constructor. More...
FrameHeader &	operator= (const FrameHeader &obj)
	Copy assignment operator. More...
bool	operator== (const FrameHeader &obj) const
	Equality operator. More...
bool	operator!= (const FrameHeader &obj) const
	Inequality operator. More...
Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialization. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialization. More...
FwSizeType	serializedSize () const
	Get the dynamic serialized size of the struct. More...
Svc::FprimeProtocol::TokenType	get_startWord () const
	Get member startWord. More...
Svc::FprimeProtocol::TokenType	get_lengthField () const
	Get member lengthField. More...
void	set (Svc::FprimeProtocol::TokenType startWord, Svc::FprimeProtocol::TokenType lengthField)
	Set all members. More...
void	set_startWord (Svc::FprimeProtocol::TokenType startWord)
	Set member startWord. More...
void	set_lengthField (Svc::FprimeProtocol::TokenType lengthField)
	Set member lengthField. More...
Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Protected Attributes
Svc::FprimeProtocol::TokenType	m_startWord
Svc::FprimeProtocol::TokenType	m_lengthField

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	Virtual destructor. More...

Detailed Description

Describes the frame header format for the F Prime communications protocol.

Definition at line 21 of file FrameHeaderSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 31 of file FrameHeaderSerializableAc.hpp.

Constructor & Destructor Documentation

FrameHeader() [1/3]

Svc::FprimeProtocol::FrameHeader::FrameHeader

(

)

Constructor (default value)

Definition at line 19 of file FrameHeaderSerializableAc.cpp.

FrameHeader() [2/3]

Svc::FprimeProtocol::FrameHeader::FrameHeader	(	Svc::FprimeProtocol::TokenType	startWord,
		Svc::FprimeProtocol::TokenType	lengthField
	)

Member constructor.

Definition at line 28 of file FrameHeaderSerializableAc.cpp.

FrameHeader() [3/3]

Svc::FprimeProtocol::FrameHeader::FrameHeader

(

const FrameHeader &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 40 of file FrameHeaderSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::FprimeProtocol::FrameHeader::deserializeFrom ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  )

virtual

Deserialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 115 of file FrameHeaderSerializableAc.cpp.

get_lengthField()

Svc::FprimeProtocol::TokenType Svc::FprimeProtocol::FrameHeader::get_lengthField ( ) const

inline

Get member lengthField.

Definition at line 130 of file FrameHeaderSerializableAc.hpp.

get_startWord()

Svc::FprimeProtocol::TokenType Svc::FprimeProtocol::FrameHeader::get_startWord ( ) const

inline

Get member startWord.

Definition at line 124 of file FrameHeaderSerializableAc.hpp.

operator!=()

bool Svc::FprimeProtocol::FrameHeader::operator!=

(

const FrameHeader &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 74 of file FrameHeaderSerializableAc.cpp.

operator=()

FrameHeader & Svc::FprimeProtocol::FrameHeader::operator=

(

const FrameHeader &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 53 of file FrameHeaderSerializableAc.cpp.

operator==()

bool Svc::FprimeProtocol::FrameHeader::operator==

(

const FrameHeader &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 64 of file FrameHeaderSerializableAc.cpp.

serializedSize()

FwSizeType Svc::FprimeProtocol::FrameHeader::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 135 of file FrameHeaderSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::FprimeProtocol::FrameHeader::serializeTo ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  ) const

virtual

Serialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 95 of file FrameHeaderSerializableAc.cpp.

set()

void Svc::FprimeProtocol::FrameHeader::set	(	Svc::FprimeProtocol::TokenType	startWord,
		Svc::FprimeProtocol::TokenType	lengthField
	)

Set all members.

Definition at line 171 of file FrameHeaderSerializableAc.cpp.

set_lengthField()

void Svc::FprimeProtocol::FrameHeader::set_lengthField

(

Svc::FprimeProtocol::TokenType

lengthField

)

Set member lengthField.

Definition at line 187 of file FrameHeaderSerializableAc.cpp.

set_startWord()

void Svc::FprimeProtocol::FrameHeader::set_startWord

(

Svc::FprimeProtocol::TokenType

startWord

)

Set member startWord.

Definition at line 181 of file FrameHeaderSerializableAc.cpp.

Member Data Documentation

m_lengthField

Svc::FprimeProtocol::TokenType Svc::FprimeProtocol::FrameHeader::m_lengthField

protected

Definition at line 158 of file FrameHeaderSerializableAc.hpp.

m_startWord

Svc::FprimeProtocol::TokenType Svc::FprimeProtocol::FrameHeader::m_startWord

protected

Definition at line 157 of file FrameHeaderSerializableAc.hpp.

---

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

• Svc/FprimeProtocol/FrameHeaderSerializableAc.hpp
• Svc/FprimeProtocol/FrameHeaderSerializableAc.cpp