Os::GenericStatus Class Reference

FPP shadow-enum representing Os::Generic::Status. More...

#include <Os/Models/GenericStatusEnumAc.hpp>

Inheritance diagram for Os::GenericStatus:

Public Types
enum	T { OP_OK = 0 , ERROR = 1 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 2 }
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
	GenericStatus ()
	Constructor (default value of OP_OK) More...
	GenericStatus (const T e1)
	Constructor (user-provided value) More...
	GenericStatus (const GenericStatus &obj)
	Copy constructor. More...
GenericStatus &	operator= (const GenericStatus &obj)
	Copy assignment operator (object) More...
GenericStatus &	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

FPP shadow-enum representing Os::Generic::Status.

Definition at line 17 of file GenericStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Os::GenericStatus::SerialType

The serial representation type.

Definition at line 28 of file GenericStatusEnumAc.hpp.

t

typedef T Os::GenericStatus::t

For backwards compatibility.

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

T

enum Os::GenericStatus::T

The raw enum type.

Enumerator
OP_OK	operation okay
ERROR	error return value

Definition at line 31 of file GenericStatusEnumAc.hpp.

Constructor & Destructor Documentation

GenericStatus() [1/3]

Os::GenericStatus::GenericStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 61 of file GenericStatusEnumAc.hpp.

GenericStatus() [2/3]

Os::GenericStatus::GenericStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 67 of file GenericStatusEnumAc.hpp.

GenericStatus() [3/3]

Os::GenericStatus::GenericStatus ( const GenericStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 75 of file GenericStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Os::GenericStatus::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 GenericStatusEnumAc.cpp.

isValid()

bool Os::GenericStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file GenericStatusEnumAc.cpp.

operator T()

Os::GenericStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 99 of file GenericStatusEnumAc.hpp.

operator!=()

bool Os::GenericStatus::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 111 of file GenericStatusEnumAc.hpp.

operator=() [1/2]

GenericStatus & Os::GenericStatus::operator=

(

const GenericStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file GenericStatusEnumAc.cpp.

operator=() [2/2]

GenericStatus & Os::GenericStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file GenericStatusEnumAc.cpp.

operator==()

bool Os::GenericStatus::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 105 of file GenericStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Os::GenericStatus::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 GenericStatusEnumAc.cpp.

Member Data Documentation

e

T Os::GenericStatus::e

The raw enum value.

Definition at line 161 of file GenericStatusEnumAc.hpp.

---

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

• Os/Models/GenericStatusEnumAc.hpp
• Os/Models/GenericStatusEnumAc.cpp