Os::CountingSemaphoreStatus Class Reference

FPP shadow-enum representing Os::CountingSemaphore::Status. More...

#include <Os/Models/CountingSemaphoreStatusEnumAc.hpp>

Inheritance diagram for Os::CountingSemaphoreStatus:

Public Types
enum	T {   OP_OK = 0, ERROR_TIMEOUT = 1, ERROR_INVALID = 2, ERROR_NOT_IMPLEMENTED = 3,   NOT_SUPPORTED = 4, ERROR_OTHER = 5 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 6 }
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
	CountingSemaphoreStatus ()
	Constructor (default value of OP_OK) More...
	CountingSemaphoreStatus (const enum T e1)
	Constructor (user-provided value) More...
	CountingSemaphoreStatus (const CountingSemaphoreStatus &obj)
	Copy constructor. More...
CountingSemaphoreStatus &	operator= (const CountingSemaphoreStatus &obj)
	Copy assignment operator (object) More...
CountingSemaphoreStatus &	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::CountingSemaphore::Status.

Definition at line 17 of file CountingSemaphoreStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Os::CountingSemaphoreStatus::SerialType

The serial representation type.

Definition at line 28 of file CountingSemaphoreStatusEnumAc.hpp.

t

typedef enum T Os::CountingSemaphoreStatus::t

For backwards compatibility.

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

T

enum Os::CountingSemaphoreStatus::T

The raw enum type.

Enumerator
OP_OK	Operation was successful.
ERROR_TIMEOUT	Timeout occurred during wait.
ERROR_INVALID	Invalid semaphore or argument.
ERROR_NOT_IMPLEMENTED	Feature not implemented.
NOT_SUPPORTED	CountingSemaphore does not support operation.
ERROR_OTHER	All other errors.

Definition at line 31 of file CountingSemaphoreStatusEnumAc.hpp.

Constructor & Destructor Documentation

CountingSemaphoreStatus() [1/3]

Os::CountingSemaphoreStatus::CountingSemaphoreStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 69 of file CountingSemaphoreStatusEnumAc.hpp.

CountingSemaphoreStatus() [2/3]

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

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 75 of file CountingSemaphoreStatusEnumAc.hpp.

CountingSemaphoreStatus() [3/3]

Os::CountingSemaphoreStatus::CountingSemaphoreStatus ( const CountingSemaphoreStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 83 of file CountingSemaphoreStatusEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Os::CountingSemaphoreStatus::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 CountingSemaphoreStatusEnumAc.cpp.

isValid()

bool Os::CountingSemaphoreStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file CountingSemaphoreStatusEnumAc.cpp.

operator enum T()

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

inline

Conversion operator.

Definition at line 107 of file CountingSemaphoreStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 119 of file CountingSemaphoreStatusEnumAc.hpp.

operator=() [1/2]

CountingSemaphoreStatus & Os::CountingSemaphoreStatus::operator=

(

const CountingSemaphoreStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file CountingSemaphoreStatusEnumAc.cpp.

operator=() [2/2]

CountingSemaphoreStatus & Os::CountingSemaphoreStatus::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file CountingSemaphoreStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 113 of file CountingSemaphoreStatusEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Os::CountingSemaphoreStatus::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 CountingSemaphoreStatusEnumAc.cpp.

Member Data Documentation

e

enum T Os::CountingSemaphoreStatus::e

The raw enum value.

Definition at line 171 of file CountingSemaphoreStatusEnumAc.hpp.

---

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

• Os/Models/CountingSemaphoreStatusEnumAc.hpp
• Os/Models/CountingSemaphoreStatusEnumAc.cpp