Drv::ByteStreamStatus Class Reference

Status returned by the send call. More...

#include <Drv/ByteStreamDriverModel/ByteStreamStatusEnumAc.hpp>

Inheritance diagram for Drv::ByteStreamStatus:

Public Types
enum	T { OP_OK = 0, SEND_RETRY = 1, RECV_NO_DATA = 2, OTHER_ERROR = 3 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 4 }
typedef I32	SerialType
	The serial representation type. More...
typedef T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	ByteStreamStatus ()
	Constructor (default value of OP_OK) More...
	ByteStreamStatus (const T e1)
	Constructor (user-provided value) More...
	ByteStreamStatus (const ByteStreamStatus &obj)
	Copy constructor. More...
ByteStreamStatus &	operator= (const ByteStreamStatus &obj)
	Copy assignment operator (object) More...
ByteStreamStatus &	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...

Detailed Description

Status returned by the send call.

Definition at line 17 of file ByteStreamStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Drv::ByteStreamStatus::SerialType

The serial representation type.

Definition at line 28 of file ByteStreamStatusEnumAc.hpp.

t

typedef T Drv::ByteStreamStatus::t

For backwards compatibility.

Definition at line 43 of file ByteStreamStatusEnumAc.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 51 of file ByteStreamStatusEnumAc.hpp.

T

enum Drv::ByteStreamStatus::T

The raw enum type.

Enumerator
OP_OK	Operation worked as expected.
SEND_RETRY	Data send should be retried.
RECV_NO_DATA	Receive worked, but there was no data.
OTHER_ERROR	Error occurred, retrying may succeed.

Definition at line 31 of file ByteStreamStatusEnumAc.hpp.

Constructor & Destructor Documentation

ByteStreamStatus() [1/3]

Drv::ByteStreamStatus::ByteStreamStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 65 of file ByteStreamStatusEnumAc.hpp.

ByteStreamStatus() [2/3]

Drv::ByteStreamStatus::ByteStreamStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 71 of file ByteStreamStatusEnumAc.hpp.

ByteStreamStatus() [3/3]

Drv::ByteStreamStatus::ByteStreamStatus ( const ByteStreamStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 79 of file ByteStreamStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Drv::ByteStreamStatus::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 ByteStreamStatusEnumAc.cpp.

isValid()

bool Drv::ByteStreamStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file ByteStreamStatusEnumAc.cpp.

operator T()

Drv::ByteStreamStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 103 of file ByteStreamStatusEnumAc.hpp.

operator!=()

bool Drv::ByteStreamStatus::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 115 of file ByteStreamStatusEnumAc.hpp.

operator=() [1/2]

ByteStreamStatus & Drv::ByteStreamStatus::operator=

(

const ByteStreamStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file ByteStreamStatusEnumAc.cpp.

operator=() [2/2]

ByteStreamStatus & Drv::ByteStreamStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file ByteStreamStatusEnumAc.cpp.

operator==()

bool Drv::ByteStreamStatus::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 109 of file ByteStreamStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Drv::ByteStreamStatus::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 ByteStreamStatusEnumAc.cpp.

Member Data Documentation

e

T Drv::ByteStreamStatus::e

The raw enum value.

Definition at line 165 of file ByteStreamStatusEnumAc.hpp.

---

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

• Drv/ByteStreamDriverModel/ByteStreamStatusEnumAc.hpp
• Drv/ByteStreamDriverModel/ByteStreamStatusEnumAc.cpp