Fw::DeserialStatus Class Reference

Deserialization status. More...

#include <docs-cache/F-Prime/Fw/Types/DeserialStatusEnumAc.hpp>

Inheritance diagram for Fw::DeserialStatus:

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.
typedef T	t
	For backwards compatibility.

Public Member Functions
	DeserialStatus ()
	Constructor (default value of OK)
	DeserialStatus (const T e)
	Constructor (user-provided value)
	DeserialStatus (const DeserialStatus &obj)
	Copy constructor.
DeserialStatus &	operator= (const DeserialStatus &obj)
	Copy assignment operator (object)
DeserialStatus &	operator= (T e)
	Copy assignment operator (raw enum)
	operator T () const
	Conversion operator.
bool	operator== (T e) const
	Equality operator.
bool	operator!= (T e) const
	Inequality operator.
bool	isValid () const
	Check raw enum value for validity.
Fw::SerializeStatus	serialize (Fw::SerializeBufferBase &buffer) const
	Serialize raw enum value to SerialType.
Fw::SerializeStatus	deserialize (Fw::SerializeBufferBase &buffer)
	Deserialize raw enum value from SerialType.

Public Attributes
T	e
	The raw enum value.

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor.
virtual	~Serializable ()
	destructor

Detailed Description

Deserialization status.

Definition at line 17 of file DeserialStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Fw::DeserialStatus::SerialType

The serial representation type.

Definition at line 28 of file DeserialStatusEnumAc.hpp.

t

typedef T Fw::DeserialStatus::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

enum Fw::DeserialStatus::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 e )

inline

Constructor (user-provided value)

Parameters

e	The raw enum value

Definition at line 72 of file DeserialStatusEnumAc.hpp.

DeserialStatus() [3/3]

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

inline

Copy constructor.

Parameters

obj	The 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

buffer

The 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 e ) 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

obj	The source object

Definition at line 19 of file DeserialStatusEnumAc.cpp.

operator=() [2/2]

DeserialStatus & Fw::DeserialStatus::operator=

(

T

e

)

Copy assignment operator (raw enum)

Parameters

e	The enum value

Definition at line 26 of file DeserialStatusEnumAc.cpp.

operator==()

bool Fw::DeserialStatus::operator== ( T e ) 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

buffer

The 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:

• docs-cache/F-Prime/Fw/Types/DeserialStatusEnumAc.hpp
• docs-cache/F-Prime/Fw/Types/DeserialStatusEnumAc.cpp