Svc::Fpy::DirectiveErrorCode Class Reference

#include <Svc/FpySequencer/DirectiveErrorCodeEnumAc.hpp>

Inheritance diagram for Svc::Fpy::DirectiveErrorCode:

Public Types
enum	T {   NO_ERROR = 0, STMT_OUT_OF_BOUNDS = 1, TLM_GET_NOT_CONNECTED = 2, TLM_CHAN_NOT_FOUND = 3,   PRM_GET_NOT_CONNECTED = 4, PRM_NOT_FOUND = 5, CMD_SERIALIZE_FAILURE = 6, EXIT_WITH_ERROR = 7,   STACK_ACCESS_OUT_OF_BOUNDS = 8, STACK_OVERFLOW = 9, DOMAIN_ERROR = 10, FLAG_IDX_OUT_OF_BOUNDS = 11,   ARRAY_OUT_OF_BOUNDS = 12, ARITHMETIC_OVERFLOW = 13, ARITHMETIC_UNDERFLOW = 14, FRAME_START_OUT_OF_BOUNDS = 15,   STACK_UNDERFLOW = 16 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 17 }
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
	DirectiveErrorCode ()
	Constructor (default value of NO_ERROR) More...
	DirectiveErrorCode (const enum T e1)
	Constructor (user-provided value) More...
	DirectiveErrorCode (const DirectiveErrorCode &obj)
	Copy constructor. More...
DirectiveErrorCode &	operator= (const DirectiveErrorCode &obj)
	Copy assignment operator (object) More...
DirectiveErrorCode &	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

Definition at line 18 of file DirectiveErrorCodeEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Svc::Fpy::DirectiveErrorCode::SerialType

The serial representation type.

Definition at line 29 of file DirectiveErrorCodeEnumAc.hpp.

t

typedef enum T Svc::Fpy::DirectiveErrorCode::t

For backwards compatibility.

Definition at line 53 of file DirectiveErrorCodeEnumAc.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 61 of file DirectiveErrorCodeEnumAc.hpp.

T

enum Svc::Fpy::DirectiveErrorCode::T

The raw enum type.

Enumerator
NO_ERROR
STMT_OUT_OF_BOUNDS
TLM_GET_NOT_CONNECTED
TLM_CHAN_NOT_FOUND
PRM_GET_NOT_CONNECTED
PRM_NOT_FOUND
CMD_SERIALIZE_FAILURE
EXIT_WITH_ERROR
STACK_ACCESS_OUT_OF_BOUNDS
STACK_OVERFLOW
DOMAIN_ERROR
FLAG_IDX_OUT_OF_BOUNDS
ARRAY_OUT_OF_BOUNDS
ARITHMETIC_OVERFLOW
ARITHMETIC_UNDERFLOW
FRAME_START_OUT_OF_BOUNDS
STACK_UNDERFLOW

Definition at line 32 of file DirectiveErrorCodeEnumAc.hpp.

Constructor & Destructor Documentation

DirectiveErrorCode() [1/3]

Svc::Fpy::DirectiveErrorCode::DirectiveErrorCode ( )

inline

Constructor (default value of NO_ERROR)

Definition at line 75 of file DirectiveErrorCodeEnumAc.hpp.

DirectiveErrorCode() [2/3]

Svc::Fpy::DirectiveErrorCode::DirectiveErrorCode ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 81 of file DirectiveErrorCodeEnumAc.hpp.

DirectiveErrorCode() [3/3]

Svc::Fpy::DirectiveErrorCode::DirectiveErrorCode ( const DirectiveErrorCode &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 89 of file DirectiveErrorCodeEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::Fpy::DirectiveErrorCode::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 DirectiveErrorCodeEnumAc.cpp.

isValid()

bool Svc::Fpy::DirectiveErrorCode::isValid

(

)

const

Check raw enum value for validity.

Definition at line 51 of file DirectiveErrorCodeEnumAc.cpp.

operator enum T()

Svc::Fpy::DirectiveErrorCode::operator enum T ( ) const

inline

Conversion operator.

Definition at line 113 of file DirectiveErrorCodeEnumAc.hpp.

operator!=()

bool Svc::Fpy::DirectiveErrorCode::operator!= ( enum T  e1 ) const

inline

Inequality operator.

Definition at line 125 of file DirectiveErrorCodeEnumAc.hpp.

operator=() [1/2]

DirectiveErrorCode & Svc::Fpy::DirectiveErrorCode::operator=

(

const DirectiveErrorCode &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file DirectiveErrorCodeEnumAc.cpp.

operator=() [2/2]

DirectiveErrorCode & Svc::Fpy::DirectiveErrorCode::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file DirectiveErrorCodeEnumAc.cpp.

operator==()

bool Svc::Fpy::DirectiveErrorCode::operator== ( enum T  e1 ) const

inline

Equality operator.

Definition at line 119 of file DirectiveErrorCodeEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Svc::Fpy::DirectiveErrorCode::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 DirectiveErrorCodeEnumAc.cpp.

Member Data Documentation

e

enum T Svc::Fpy::DirectiveErrorCode::e

The raw enum value.

Definition at line 177 of file DirectiveErrorCodeEnumAc.hpp.

---

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

• Svc/FpySequencer/DirectiveErrorCodeEnumAc.hpp
• Svc/FpySequencer/DirectiveErrorCodeEnumAc.cpp