F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Fw::DeserialStatus Class Reference

Deserialization status. More...

#include <Fw/Types/DeserialStatusEnumAc.hpp>

Inheritance diagram for Fw::DeserialStatus:
Fw::Serializable

Public Types

enum  T {
  OK = 0 , BUFFER_EMPTY = 3 , FORMAT_ERROR = 4 , SIZE_MISMATCH = 5 ,
  TYPE_MISMATCH = 6
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 5 }
 
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

 DeserialStatus ()
 Constructor (default value of OK) More...
 
 DeserialStatus (const T e1)
 Constructor (user-provided value) More...
 
 DeserialStatus (const DeserialStatus &obj)
 Copy constructor. More...
 
DeserialStatusoperator= (const DeserialStatus &obj)
 Copy assignment operator (object) More...
 
DeserialStatusoperator= (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

Deserialization status.

Definition at line 17 of file DeserialStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file DeserialStatusEnumAc.hpp.

◆ t

For backwards compatibility.

Definition at line 44 of file DeserialStatusEnumAc.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 52 of file DeserialStatusEnumAc.hpp.

◆ T

The raw enum type.

Enumerator
OK 
BUFFER_EMPTY 

Deserialization buffer was empty when trying to read data.

FORMAT_ERROR 

Deserialization data had incorrect values (unexpected data types)

SIZE_MISMATCH 

Data was left in in the buffer, but not enough to deserialize.

TYPE_MISMATCH 

Deserialized type ID didn't match.

Definition at line 31 of file DeserialStatusEnumAc.hpp.

Constructor & Destructor Documentation

◆ DeserialStatus() [1/3]

Fw::DeserialStatus::DeserialStatus ( )
inline

Constructor (default value of OK)

Definition at line 66 of file DeserialStatusEnumAc.hpp.

◆ DeserialStatus() [2/3]

Fw::DeserialStatus::DeserialStatus ( const T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 72 of file DeserialStatusEnumAc.hpp.

◆ DeserialStatus() [3/3]

Fw::DeserialStatus::DeserialStatus ( const DeserialStatus obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 80 of file DeserialStatusEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Fw::DeserialStatus::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 64 of file DeserialStatusEnumAc.cpp.

◆ isValid()

bool Fw::DeserialStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file DeserialStatusEnumAc.cpp.

◆ operator T()

Fw::DeserialStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 104 of file DeserialStatusEnumAc.hpp.

◆ operator!=()

bool Fw::DeserialStatus::operator!= ( T  e1) const
inline

Inequality operator.

Definition at line 116 of file DeserialStatusEnumAc.hpp.

◆ operator=() [1/2]

DeserialStatus & Fw::DeserialStatus::operator= ( const DeserialStatus obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file DeserialStatusEnumAc.cpp.

◆ operator=() [2/2]

DeserialStatus & Fw::DeserialStatus::operator= ( T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 26 of file DeserialStatusEnumAc.cpp.

◆ operator==()

bool Fw::DeserialStatus::operator== ( T  e1) const
inline

Equality operator.

Definition at line 110 of file DeserialStatusEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Fw::DeserialStatus::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 55 of file DeserialStatusEnumAc.cpp.

Member Data Documentation

◆ e

T Fw::DeserialStatus::e

The raw enum value.

Definition at line 166 of file DeserialStatusEnumAc.hpp.


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