F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
FPP shadow-enum representing Os::Task::Status. More...
#include <Os/Models/TaskStatusEnumAc.hpp>
Public Types | |
enum | T { OP_OK = 0 , INVALID_HANDLE = 1 , INVALID_PARAMS = 2 , INVALID_STACK = 3 , UNKNOWN_ERROR = 4 , INVALID_AFFINITY = 5 , DELAY_ERROR = 6 , JOIN_ERROR = 7 , ERROR_RESOURCES = 8 , ERROR_PERMISSION = 9 , INVALID_STATE = 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 = NATIVE_UINT_TYPE |
Public Member Functions | |
TaskStatus () | |
Constructor (default value of OP_OK) More... | |
TaskStatus (const T e1) | |
Constructor (user-provided value) More... | |
TaskStatus (const TaskStatus &obj) | |
Copy constructor. More... | |
TaskStatus & | operator= (const TaskStatus &obj) |
Copy assignment operator (object) More... | |
TaskStatus & | 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... | |
FPP shadow-enum representing Os::Task::Status.
Definition at line 17 of file TaskStatusEnumAc.hpp.
typedef I32 Os::TaskStatus::SerialType |
The serial representation type.
Definition at line 28 of file TaskStatusEnumAc.hpp.
typedef T Os::TaskStatus::t |
For backwards compatibility.
Definition at line 57 of file TaskStatusEnumAc.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 TaskStatusEnumAc.hpp.
enum Os::TaskStatus::T |
The raw enum type.
Enumerator | |
---|---|
OP_OK | message sent/received okay |
INVALID_HANDLE | Task handle invalid. |
INVALID_PARAMS | started task with invalid parameters |
INVALID_STACK | started with invalid stack size |
UNKNOWN_ERROR | unexpected error return value |
INVALID_AFFINITY | unable to set the task affinity |
DELAY_ERROR | error trying to delay the task |
JOIN_ERROR | error trying to join the task |
ERROR_RESOURCES | unable to allocate more tasks |
ERROR_PERMISSION | permissions error setting-up tasks |
INVALID_STATE | Task is in an invalid state for the operation. |
Definition at line 31 of file TaskStatusEnumAc.hpp.
|
inline |
Constructor (default value of OP_OK)
Definition at line 79 of file TaskStatusEnumAc.hpp.
|
inline |
Constructor (user-provided value)
e1 | The raw enum value |
Definition at line 85 of file TaskStatusEnumAc.hpp.
|
inline |
Copy constructor.
obj | The source object |
Definition at line 93 of file TaskStatusEnumAc.hpp.
|
virtual |
Deserialize raw enum value from SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 63 of file TaskStatusEnumAc.cpp.
bool Os::TaskStatus::isValid | ( | ) | const |
Check raw enum value for validity.
Definition at line 48 of file TaskStatusEnumAc.cpp.
|
inline |
Conversion operator.
Definition at line 117 of file TaskStatusEnumAc.hpp.
|
inline |
Inequality operator.
Definition at line 129 of file TaskStatusEnumAc.hpp.
TaskStatus & Os::TaskStatus::operator= | ( | const TaskStatus & | obj | ) |
Copy assignment operator (object)
obj | The source object |
Definition at line 19 of file TaskStatusEnumAc.cpp.
TaskStatus & Os::TaskStatus::operator= | ( | T | e1 | ) |
Copy assignment operator (raw enum)
e1 | The enum value |
Definition at line 26 of file TaskStatusEnumAc.cpp.
|
inline |
Equality operator.
Definition at line 123 of file TaskStatusEnumAc.hpp.
|
virtual |
Serialize raw enum value to SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 54 of file TaskStatusEnumAc.cpp.
T Os::TaskStatus::e |
The raw enum value.
Definition at line 179 of file TaskStatusEnumAc.hpp.