![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
FPP shadow-enum representing Os::Queue::Status. More...
#include <Os/Models/QueueStatusEnumAc.hpp>
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... | |
![]() | |
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 | |
![]() | |
Serializable () | |
Default constructor. More... | |
virtual | ~Serializable () |
destructor More... | |
FPP shadow-enum representing Os::Queue::Status.
Definition at line 17 of file QueueStatusEnumAc.hpp.
typedef I32 Os::QueueStatus::SerialType |
The serial representation type.
Definition at line 28 of file QueueStatusEnumAc.hpp.
typedef T Os::QueueStatus::t |
For backwards compatibility.
Definition at line 57 of file QueueStatusEnumAc.hpp.
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.
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.
|
inline |
Constructor (default value of OP_OK)
Definition at line 79 of file QueueStatusEnumAc.hpp.
|
inline |
Constructor (user-provided value)
e1 | The raw enum value |
Definition at line 85 of file QueueStatusEnumAc.hpp.
|
inline |
Copy constructor.
obj | The source object |
Definition at line 93 of file QueueStatusEnumAc.hpp.
|
virtual |
Deserialize raw enum value from SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 64 of file QueueStatusEnumAc.cpp.
bool Os::QueueStatus::isValid | ( | ) | const |
Check raw enum value for validity.
Definition at line 49 of file QueueStatusEnumAc.cpp.
|
inline |
Conversion operator.
Definition at line 117 of file QueueStatusEnumAc.hpp.
|
inline |
Inequality operator.
Definition at line 129 of file QueueStatusEnumAc.hpp.
QueueStatus & Os::QueueStatus::operator= | ( | const QueueStatus & | obj | ) |
Copy assignment operator (object)
obj | The source object |
Definition at line 20 of file QueueStatusEnumAc.cpp.
QueueStatus & Os::QueueStatus::operator= | ( | T | e1 | ) |
Copy assignment operator (raw enum)
e1 | The enum value |
Definition at line 27 of file QueueStatusEnumAc.cpp.
|
inline |
Equality operator.
Definition at line 123 of file QueueStatusEnumAc.hpp.
|
virtual |
Serialize raw enum value to SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 55 of file QueueStatusEnumAc.cpp.
T Os::QueueStatus::e |
The raw enum value.
Definition at line 179 of file QueueStatusEnumAc.hpp.