Os::QueueStatus Class Reference

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

#include <Os/Models/QueueStatusEnumAc.hpp>

Inheritance diagram for Os::QueueStatus:

Public Types
enum	T {   OP_OK = 0, ALREADY_CREATED = 1, EMPTY = 2, UNINITIALIZED = 3,   SIZE_MISMATCH = 4, SEND_ERROR = 5, RECEIVE_ERROR = 6, INVALID_PRIORITY = 7,   FULL = 8, NOT_SUPPORTED = 9, UNKNOWN_ERROR = 10 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 11 }
typedef I32	SerialType
	The serial representation type. More...
typedef T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	QueueStatus ()
	Constructor (default value of OP_OK) More...
	QueueStatus (const T e1)
	Constructor (user-provided value) More...
	QueueStatus (const QueueStatus &obj)
	Copy constructor. More...
QueueStatus &	operator= (const QueueStatus &obj)
	Copy assignment operator (object) More...
QueueStatus &	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::Queue::Status.

Definition at line 17 of file QueueStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Os::QueueStatus::SerialType

The serial representation type.

Definition at line 28 of file QueueStatusEnumAc.hpp.

t

typedef T Os::QueueStatus::t

For backwards compatibility.

Definition at line 57 of file QueueStatusEnumAc.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 65 of file QueueStatusEnumAc.hpp.

T

enum Os::QueueStatus::T

The raw enum type.

Enumerator
OP_OK	message sent/received okay
ALREADY_CREATED	creating an already created queue
EMPTY	If non-blocking, all the messages have been drained.
UNINITIALIZED	Queue wasn't initialized successfully.
SIZE_MISMATCH	attempted to send or receive with buffer too large, too small
SEND_ERROR	message send error
RECEIVE_ERROR	message receive error
INVALID_PRIORITY	invalid priority requested
FULL	Queue was full when attempting to send a message.
NOT_SUPPORTED	Queue feature is not supported.
UNKNOWN_ERROR	Unexpected error; can't match with returns.

Definition at line 31 of file QueueStatusEnumAc.hpp.

Constructor & Destructor Documentation

QueueStatus() [1/3]

Os::QueueStatus::QueueStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 79 of file QueueStatusEnumAc.hpp.

QueueStatus() [2/3]

Os::QueueStatus::QueueStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 85 of file QueueStatusEnumAc.hpp.

QueueStatus() [3/3]

Os::QueueStatus::QueueStatus ( const QueueStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 93 of file QueueStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Os::QueueStatus::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 64 of file QueueStatusEnumAc.cpp.

isValid()

bool Os::QueueStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file QueueStatusEnumAc.cpp.

operator T()

Os::QueueStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 117 of file QueueStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 129 of file QueueStatusEnumAc.hpp.

operator=() [1/2]

QueueStatus & Os::QueueStatus::operator=

(

const QueueStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file QueueStatusEnumAc.cpp.

operator=() [2/2]

QueueStatus & Os::QueueStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file QueueStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 123 of file QueueStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Os::QueueStatus::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 55 of file QueueStatusEnumAc.cpp.

Member Data Documentation

e

T Os::QueueStatus::e

The raw enum value.

Definition at line 179 of file QueueStatusEnumAc.hpp.

---

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

• Os/Models/QueueStatusEnumAc.hpp
• Os/Models/QueueStatusEnumAc.cpp