Svc::Ccsds::FrameError Class Reference

Enum representing an error during framing/deframing in the CCSDS protocols. More...

#include <Svc/Ccsds/Types/FrameErrorEnumAc.hpp>

Inheritance diagram for Svc::Ccsds::FrameError:

Public Types
enum	T {   SP_INVALID_PACKET = 0, SP_INVALID_LENGTH = 1, TC_INVALID_SCID = 2, TC_INVALID_LENGTH = 3,   TC_INVALID_VCID = 4, TC_INVALID_CRC = 5 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 6 }
typedef U8	SerialType
	The serial representation type. More...
typedef enum T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	FrameError ()
	Constructor (default value of SP_INVALID_PACKET) More...
	FrameError (const enum T e1)
	Constructor (user-provided value) More...
	FrameError (const FrameError &obj)
	Copy constructor. More...
FrameError &	operator= (const FrameError &obj)
	Copy assignment operator (object) More...
FrameError &	operator= (enum T e1)
	Copy assignment operator (raw enum) More...
	operator enum T () const
	Conversion operator. More...
bool	operator== (enum T e1) const
	Equality operator. More...
bool	operator!= (enum T e1) const
	Inequality operator. More...
bool	isValid () const
	Check raw enum value for validity. More...
Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialize raw enum value to SerialType. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialize raw enum value from SerialType. 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")

Public Attributes
enum T	e
	The raw enum value. More...

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

Detailed Description

Enum representing an error during framing/deframing in the CCSDS protocols.

Definition at line 19 of file FrameErrorEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Svc::Ccsds::FrameError::SerialType

The serial representation type.

Definition at line 30 of file FrameErrorEnumAc.hpp.

t

typedef enum T Svc::Ccsds::FrameError::t

For backwards compatibility.

Definition at line 43 of file FrameErrorEnumAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SERIALIZED_SIZE	The size of the serial representation.
NUM_CONSTANTS	The number of enumerated constants.

Definition at line 51 of file FrameErrorEnumAc.hpp.

T

enum Svc::Ccsds::FrameError::T

The raw enum type.

Enumerator
SP_INVALID_PACKET
SP_INVALID_LENGTH
TC_INVALID_SCID
TC_INVALID_LENGTH
TC_INVALID_VCID
TC_INVALID_CRC

Definition at line 33 of file FrameErrorEnumAc.hpp.

Constructor & Destructor Documentation

FrameError() [1/3]

Svc::Ccsds::FrameError::FrameError ( )

inline

Constructor (default value of SP_INVALID_PACKET)

Definition at line 65 of file FrameErrorEnumAc.hpp.

FrameError() [2/3]

Svc::Ccsds::FrameError::FrameError ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 71 of file FrameErrorEnumAc.hpp.

FrameError() [3/3]

Svc::Ccsds::FrameError::FrameError ( const FrameError &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 79 of file FrameErrorEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::Ccsds::FrameError::deserializeFrom ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 70 of file FrameErrorEnumAc.cpp.

isValid()

bool Svc::Ccsds::FrameError::isValid

(

)

const

Check raw enum value for validity.

Definition at line 51 of file FrameErrorEnumAc.cpp.

operator enum T()

Svc::Ccsds::FrameError::operator enum T ( ) const

inline

Conversion operator.

Definition at line 103 of file FrameErrorEnumAc.hpp.

operator!=()

bool Svc::Ccsds::FrameError::operator!= ( enum T  e1 ) const

inline

Inequality operator.

Definition at line 115 of file FrameErrorEnumAc.hpp.

operator=() [1/2]

FrameError & Svc::Ccsds::FrameError::operator=

(

const FrameError &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file FrameErrorEnumAc.cpp.

operator=() [2/2]

FrameError & Svc::Ccsds::FrameError::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file FrameErrorEnumAc.cpp.

operator==()

bool Svc::Ccsds::FrameError::operator== ( enum T  e1 ) const

inline

Equality operator.

Definition at line 109 of file FrameErrorEnumAc.hpp.

serializeTo()

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

virtual

Serialize raw enum value to SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 57 of file FrameErrorEnumAc.cpp.

Member Data Documentation

e

enum T Svc::Ccsds::FrameError::e

The raw enum value.

Definition at line 167 of file FrameErrorEnumAc.hpp.

---

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

• Svc/Ccsds/Types/FrameErrorEnumAc.hpp
• Svc/Ccsds/Types/FrameErrorEnumAc.cpp