Svc::FprimeProtocol::FrameTrailer Class Reference

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

#include <Svc/FprimeProtocol/FrameTrailerSerializableAc.hpp>

Inheritance diagram for Svc::FprimeProtocol::FrameTrailer:

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

Public Member Functions
	FrameTrailer ()
	Constructor (default value) More...
	FrameTrailer (U32 crcField)
	Member constructor. More...
	FrameTrailer (const FrameTrailer &obj)
	Copy constructor. More...
FrameTrailer &	operator= (const FrameTrailer &obj)
	Copy assignment operator. More...
bool	operator== (const FrameTrailer &obj) const
	Equality operator. More...
bool	operator!= (const FrameTrailer &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...
U32	get_crcField () const
	Get member crcField. More...
void	set (U32 crcField)
	Set all members. More...
void	set_crcField (U32 crcField)
	Set member crcField. 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
U32	m_crcField

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

Detailed Description

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

Definition at line 20 of file FrameTrailerSerializableAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 30 of file FrameTrailerSerializableAc.hpp.

Constructor & Destructor Documentation

FrameTrailer() [1/3]

Svc::FprimeProtocol::FrameTrailer::FrameTrailer

(

)

Constructor (default value)

Definition at line 19 of file FrameTrailerSerializableAc.cpp.

FrameTrailer() [2/3]

Svc::FprimeProtocol::FrameTrailer::FrameTrailer

(

U32

crcField

)

Member constructor.

Definition at line 27 of file FrameTrailerSerializableAc.cpp.

FrameTrailer() [3/3]

Svc::FprimeProtocol::FrameTrailer::FrameTrailer

(

const FrameTrailer &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 35 of file FrameTrailerSerializableAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::FprimeProtocol::FrameTrailer::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 101 of file FrameTrailerSerializableAc.cpp.

get_crcField()

U32 Svc::FprimeProtocol::FrameTrailer::get_crcField ( ) const

inline

Get member crcField.

Definition at line 119 of file FrameTrailerSerializableAc.hpp.

operator!=()

bool Svc::FprimeProtocol::FrameTrailer::operator!=

(

const FrameTrailer &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 64 of file FrameTrailerSerializableAc.cpp.

operator=()

FrameTrailer & Svc::FprimeProtocol::FrameTrailer::operator=

(

const FrameTrailer &

obj

)

Copy assignment operator.

Parameters

obj	The source object

Definition at line 47 of file FrameTrailerSerializableAc.cpp.

operator==()

bool Svc::FprimeProtocol::FrameTrailer::operator==

(

const FrameTrailer &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 58 of file FrameTrailerSerializableAc.cpp.

serializedSize()

FwSizeType Svc::FprimeProtocol::FrameTrailer::serializedSize

(

)

const

Get the dynamic serialized size of the struct.

Definition at line 117 of file FrameTrailerSerializableAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::FprimeProtocol::FrameTrailer::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 85 of file FrameTrailerSerializableAc.cpp.

set()

void Svc::FprimeProtocol::FrameTrailer::set

(

U32

crcField

)

Set all members.

Definition at line 146 of file FrameTrailerSerializableAc.cpp.

set_crcField()

void Svc::FprimeProtocol::FrameTrailer::set_crcField

(

U32

crcField

)

Set member crcField.

Definition at line 152 of file FrameTrailerSerializableAc.cpp.

Member Data Documentation

m_crcField

U32 Svc::FprimeProtocol::FrameTrailer::m_crcField

protected

Definition at line 140 of file FrameTrailerSerializableAc.hpp.

---

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

• Svc/FprimeProtocol/FrameTrailerSerializableAc.hpp
• Svc/FprimeProtocol/FrameTrailerSerializableAc.cpp