Fw::CmdResponse Class Reference

Enum representing a command response. More...

#include <Fw/Cmd/CmdResponseEnumAc.hpp>

Inheritance diagram for Fw::CmdResponse:

Public Types
enum	T {   OK = 0 , INVALID_OPCODE = 1 , VALIDATION_ERROR = 2 , FORMAT_ERROR = 3 ,   EXECUTION_ERROR = 4 , BUSY = 5 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 6 }
typedef I32	SerialType
	The serial representation type. More...
typedef T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = NATIVE_UINT_TYPE

Public Member Functions
	CmdResponse ()
	Constructor (default value of OK) More...
	CmdResponse (const T e1)
	Constructor (user-provided value) More...
	CmdResponse (const CmdResponse &obj)
	Copy constructor. More...
CmdResponse &	operator= (const CmdResponse &obj)
	Copy assignment operator (object) More...
CmdResponse &	operator= (T e1)
	Copy assignment operator (raw enum) More...
	operator T () const
	Conversion operator. More...
bool	operator== (T e1) const
	Equality operator. More...
bool	operator!= (T e1) const
	Inequality operator. More...
bool	isValid () const
	Check raw enum value for validity. More...
Fw::SerializeStatus	serialize (Fw::SerializeBufferBase &buffer) const
	Serialize raw enum value to SerialType. More...
Fw::SerializeStatus	deserialize (Fw::SerializeBufferBase &buffer)
	Deserialize raw enum value from SerialType. More...

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

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

Detailed Description

Enum representing a command response.

Definition at line 17 of file CmdResponseEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Fw::CmdResponse::SerialType

The serial representation type.

Definition at line 28 of file CmdResponseEnumAc.hpp.

t

typedef T Fw::CmdResponse::t

For backwards compatibility.

Definition at line 47 of file CmdResponseEnumAc.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 55 of file CmdResponseEnumAc.hpp.

T

enum Fw::CmdResponse::T

The raw enum type.

Enumerator
OK	Command successfully executed.
INVALID_OPCODE	Invalid opcode dispatched.
VALIDATION_ERROR	Command failed validation.
FORMAT_ERROR	Command failed to deserialize.
EXECUTION_ERROR	Command had execution error.
BUSY	Component busy.

Definition at line 31 of file CmdResponseEnumAc.hpp.

Constructor & Destructor Documentation

CmdResponse() [1/3]

Fw::CmdResponse::CmdResponse ( )

inline

Constructor (default value of OK)

Definition at line 69 of file CmdResponseEnumAc.hpp.

CmdResponse() [2/3]

Fw::CmdResponse::CmdResponse ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 75 of file CmdResponseEnumAc.hpp.

CmdResponse() [3/3]

Fw::CmdResponse::CmdResponse ( const CmdResponse &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 83 of file CmdResponseEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Fw::CmdResponse::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 63 of file CmdResponseEnumAc.cpp.

isValid()

bool Fw::CmdResponse::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file CmdResponseEnumAc.cpp.

operator T()

Fw::CmdResponse::operator T ( ) const

inline

Conversion operator.

Definition at line 107 of file CmdResponseEnumAc.hpp.

operator!=()

bool Fw::CmdResponse::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 119 of file CmdResponseEnumAc.hpp.

operator=() [1/2]

CmdResponse & Fw::CmdResponse::operator=

(

const CmdResponse &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file CmdResponseEnumAc.cpp.

operator=() [2/2]

CmdResponse & Fw::CmdResponse::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file CmdResponseEnumAc.cpp.

operator==()

bool Fw::CmdResponse::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 113 of file CmdResponseEnumAc.hpp.

serialize()

Fw::SerializeStatus Fw::CmdResponse::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 54 of file CmdResponseEnumAc.cpp.

Member Data Documentation

e

T Fw::CmdResponse::e

The raw enum value.

Definition at line 169 of file CmdResponseEnumAc.hpp.

---

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

• Fw/Cmd/CmdResponseEnumAc.hpp
• Fw/Cmd/CmdResponseEnumAc.cpp