Drv::GpioStatus Class Reference

#include <Drv/Ports/GpioStatusEnumAc.hpp>

Inheritance diagram for Drv::GpioStatus:

Public Types
enum	T { OP_OK = 0 , NOT_OPENED = 1 , INVALID_MODE = 2 , UNKNOWN_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 = NATIVE_UINT_TYPE

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

Definition at line 16 of file GpioStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Drv::GpioStatus::SerialType

The serial representation type.

Definition at line 27 of file GpioStatusEnumAc.hpp.

t

typedef T Drv::GpioStatus::t

For backwards compatibility.

Definition at line 42 of file GpioStatusEnumAc.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 50 of file GpioStatusEnumAc.hpp.

T

enum Drv::GpioStatus::T

The raw enum type.

Enumerator
OP_OK	Operation succeeded.
NOT_OPENED	Pin was never opened.
INVALID_MODE	Operation not permitted with current configuration.
UNKNOWN_ERROR	An unknown error occurred.

Definition at line 30 of file GpioStatusEnumAc.hpp.

Constructor & Destructor Documentation

GpioStatus() [1/3]

Drv::GpioStatus::GpioStatus ( )

inline

Constructor (default value of OP_OK)

Definition at line 64 of file GpioStatusEnumAc.hpp.

GpioStatus() [2/3]

Drv::GpioStatus::GpioStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 70 of file GpioStatusEnumAc.hpp.

GpioStatus() [3/3]

Drv::GpioStatus::GpioStatus ( const GpioStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 78 of file GpioStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Drv::GpioStatus::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 63 of file GpioStatusEnumAc.cpp.

isValid()

bool Drv::GpioStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file GpioStatusEnumAc.cpp.

operator T()

Drv::GpioStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 102 of file GpioStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 114 of file GpioStatusEnumAc.hpp.

operator=() [1/2]

GpioStatus & Drv::GpioStatus::operator=

(

const GpioStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file GpioStatusEnumAc.cpp.

operator=() [2/2]

GpioStatus & Drv::GpioStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file GpioStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 108 of file GpioStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Drv::GpioStatus::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 54 of file GpioStatusEnumAc.cpp.

Member Data Documentation

e

T Drv::GpioStatus::e

The raw enum value.

Definition at line 164 of file GpioStatusEnumAc.hpp.

---

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

• Drv/Ports/GpioStatusEnumAc.hpp
• Drv/Ports/GpioStatusEnumAc.cpp