F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
Serialization status. More...
#include <Fw/Types/SerialStatusEnumAc.hpp>
Public Types | |
enum | T { OK = 0 , FORMAT_ERROR = 1 , NO_ROOM_LEFT = 2 } |
The raw enum type. More... | |
enum | { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 3 } |
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 | |
SerialStatus () | |
Constructor (default value of OK) More... | |
SerialStatus (const T e1) | |
Constructor (user-provided value) More... | |
SerialStatus (const SerialStatus &obj) | |
Copy constructor. More... | |
SerialStatus & | operator= (const SerialStatus &obj) |
Copy assignment operator (object) More... | |
SerialStatus & | 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... | |
Serialization status.
Definition at line 17 of file SerialStatusEnumAc.hpp.
typedef I32 Fw::SerialStatus::SerialType |
The serial representation type.
Definition at line 28 of file SerialStatusEnumAc.hpp.
typedef T Fw::SerialStatus::t |
For backwards compatibility.
Definition at line 41 of file SerialStatusEnumAc.hpp.
anonymous enum |
Enumerator | |
---|---|
SERIALIZED_SIZE | The size of the serial representation. |
NUM_CONSTANTS | The number of enumerated constants. |
Definition at line 49 of file SerialStatusEnumAc.hpp.
enum Fw::SerialStatus::T |
The raw enum type.
Enumerator | |
---|---|
OK | Serialization operation succeeded. |
FORMAT_ERROR | Data was the wrong format (e.g. wrong packet type) |
NO_ROOM_LEFT | No room left in the buffer to serialize data. |
Definition at line 31 of file SerialStatusEnumAc.hpp.
|
inline |
Constructor (default value of OK)
Definition at line 63 of file SerialStatusEnumAc.hpp.
|
inline |
Constructor (user-provided value)
e1 | The raw enum value |
Definition at line 69 of file SerialStatusEnumAc.hpp.
|
inline |
Copy constructor.
obj | The source object |
Definition at line 77 of file SerialStatusEnumAc.hpp.
|
virtual |
Deserialize raw enum value from SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 63 of file SerialStatusEnumAc.cpp.
bool Fw::SerialStatus::isValid | ( | ) | const |
Check raw enum value for validity.
Definition at line 48 of file SerialStatusEnumAc.cpp.
|
inline |
Conversion operator.
Definition at line 101 of file SerialStatusEnumAc.hpp.
|
inline |
Inequality operator.
Definition at line 113 of file SerialStatusEnumAc.hpp.
SerialStatus & Fw::SerialStatus::operator= | ( | const SerialStatus & | obj | ) |
Copy assignment operator (object)
obj | The source object |
Definition at line 19 of file SerialStatusEnumAc.cpp.
SerialStatus & Fw::SerialStatus::operator= | ( | T | e1 | ) |
Copy assignment operator (raw enum)
e1 | The enum value |
Definition at line 26 of file SerialStatusEnumAc.cpp.
|
inline |
Equality operator.
Definition at line 107 of file SerialStatusEnumAc.hpp.
|
virtual |
Serialize raw enum value to SerialType.
buffer | The serial buffer |
Implements Fw::Serializable.
Definition at line 54 of file SerialStatusEnumAc.cpp.
T Fw::SerialStatus::e |
The raw enum value.
Definition at line 163 of file SerialStatusEnumAc.hpp.