Os::QueueBlockingType Class Reference

FPP shadow-enum representing Os::Queue::BlockingType. More...

#include <Os/Models/QueueBlockingTypeEnumAc.hpp>

Inheritance diagram for Os::QueueBlockingType:

Public Types
enum	T { BLOCKING = 0, NONBLOCKING = 1 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 2 }
typedef U8	SerialType
	The serial representation type. More...
typedef enum T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	QueueBlockingType ()
	Constructor (default value of BLOCKING) More...
	QueueBlockingType (const enum T e1)
	Constructor (user-provided value) More...
	QueueBlockingType (const QueueBlockingType &obj)
	Copy constructor. More...
QueueBlockingType &	operator= (const QueueBlockingType &obj)
	Copy assignment operator (object) More...
QueueBlockingType &	operator= (enum T e1)
	Copy assignment operator (raw enum) More...
	operator enum T () const
	Conversion operator. More...
bool	operator== (enum T e1) const
	Equality operator. More...
bool	operator!= (enum T e1) const
	Inequality operator. More...
bool	isValid () const
	Check raw enum value for validity. More...
Fw::SerializeStatus	serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialize raw enum value to SerialType. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialize raw enum value from SerialType. More...
Public Member Functions inherited from Fw::Serializable
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

Public Attributes
enum T	e
	The raw enum value. More...

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

Detailed Description

FPP shadow-enum representing Os::Queue::BlockingType.

Definition at line 17 of file QueueBlockingTypeEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Os::QueueBlockingType::SerialType

The serial representation type.

Definition at line 28 of file QueueBlockingTypeEnumAc.hpp.

t

typedef enum T Os::QueueBlockingType::t

For backwards compatibility.

Definition at line 39 of file QueueBlockingTypeEnumAc.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 47 of file QueueBlockingTypeEnumAc.hpp.

T

enum Os::QueueBlockingType::T

The raw enum type.

Enumerator
BLOCKING	Message will block until space is available.
NONBLOCKING	Message will return with status when space is unavailable.

Definition at line 31 of file QueueBlockingTypeEnumAc.hpp.

Constructor & Destructor Documentation

QueueBlockingType() [1/3]

Os::QueueBlockingType::QueueBlockingType ( )

inline

Constructor (default value of BLOCKING)

Definition at line 61 of file QueueBlockingTypeEnumAc.hpp.

QueueBlockingType() [2/3]

Os::QueueBlockingType::QueueBlockingType ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 67 of file QueueBlockingTypeEnumAc.hpp.

QueueBlockingType() [3/3]

Os::QueueBlockingType::QueueBlockingType ( const QueueBlockingType &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 75 of file QueueBlockingTypeEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Os::QueueBlockingType::deserializeFrom ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 68 of file QueueBlockingTypeEnumAc.cpp.

isValid()

bool Os::QueueBlockingType::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file QueueBlockingTypeEnumAc.cpp.

operator enum T()

Os::QueueBlockingType::operator enum T ( ) const

inline

Conversion operator.

Definition at line 99 of file QueueBlockingTypeEnumAc.hpp.

operator!=()

bool Os::QueueBlockingType::operator!= ( enum T  e1 ) const

inline

Inequality operator.

Definition at line 111 of file QueueBlockingTypeEnumAc.hpp.

operator=() [1/2]

QueueBlockingType & Os::QueueBlockingType::operator=

(

const QueueBlockingType &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file QueueBlockingTypeEnumAc.cpp.

operator=() [2/2]

QueueBlockingType & Os::QueueBlockingType::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file QueueBlockingTypeEnumAc.cpp.

operator==()

bool Os::QueueBlockingType::operator== ( enum T  e1 ) const

inline

Equality operator.

Definition at line 105 of file QueueBlockingTypeEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Os::QueueBlockingType::serializeTo ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 55 of file QueueBlockingTypeEnumAc.cpp.

Member Data Documentation

e

enum T Os::QueueBlockingType::e

The raw enum value.

Definition at line 163 of file QueueBlockingTypeEnumAc.hpp.

---

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

• Os/Models/QueueBlockingTypeEnumAc.hpp
• Os/Models/QueueBlockingTypeEnumAc.cpp