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

Serialization status. More...

#include <Fw/Types/SerialStatusEnumAc.hpp>

Inheritance diagram for Fw::SerialStatus:
Fw::Serializable

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...
 
SerialStatusoperator= (const SerialStatus &obj)
 Copy assignment operator (object) More...
 
SerialStatusoperator= (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

Serialization status.

Definition at line 17 of file SerialStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file SerialStatusEnumAc.hpp.

◆ t

For backwards compatibility.

Definition at line 41 of file SerialStatusEnumAc.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 49 of file SerialStatusEnumAc.hpp.

◆ 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.

Constructor & Destructor Documentation

◆ SerialStatus() [1/3]

Fw::SerialStatus::SerialStatus ( )
inline

Constructor (default value of OK)

Definition at line 63 of file SerialStatusEnumAc.hpp.

◆ SerialStatus() [2/3]

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

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 69 of file SerialStatusEnumAc.hpp.

◆ SerialStatus() [3/3]

Fw::SerialStatus::SerialStatus ( const SerialStatus obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 77 of file SerialStatusEnumAc.hpp.

Member Function Documentation

◆ deserialize()

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

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file SerialStatusEnumAc.cpp.

◆ isValid()

bool Fw::SerialStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file SerialStatusEnumAc.cpp.

◆ operator T()

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

Conversion operator.

Definition at line 101 of file SerialStatusEnumAc.hpp.

◆ operator!=()

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

Inequality operator.

Definition at line 113 of file SerialStatusEnumAc.hpp.

◆ operator=() [1/2]

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

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file SerialStatusEnumAc.cpp.

◆ operator=() [2/2]

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

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 26 of file SerialStatusEnumAc.cpp.

◆ operator==()

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

Equality operator.

Definition at line 107 of file SerialStatusEnumAc.hpp.

◆ serialize()

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

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 54 of file SerialStatusEnumAc.cpp.

Member Data Documentation

◆ e

T Fw::SerialStatus::e

The raw enum value.

Definition at line 163 of file SerialStatusEnumAc.hpp.


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