Drv::I2cStatus Class Reference

#include <Drv/Ports/I2cStatusEnumAc.hpp>

Inheritance diagram for Drv::I2cStatus:

Public Types
enum	T {   I2C_OK = 0, I2C_ADDRESS_ERR = 1, I2C_WRITE_ERR = 2, I2C_READ_ERR = 3,   I2C_OPEN_ERR = 4, I2C_OTHER_ERR = 5 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 6 }
typedef U8	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
	I2cStatus ()
	Constructor (default value of I2C_OK) More...
	I2cStatus (const T e1)
	Constructor (user-provided value) More...
	I2cStatus (const I2cStatus &obj)
	Copy constructor. More...
I2cStatus &	operator= (const I2cStatus &obj)
	Copy assignment operator (object) More...
I2cStatus &	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	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
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

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 ()
	Virtual destructor. More...

Detailed Description

Definition at line 16 of file I2cStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Drv::I2cStatus::SerialType

The serial representation type.

Definition at line 27 of file I2cStatusEnumAc.hpp.

t

typedef T Drv::I2cStatus::t

For backwards compatibility.

Definition at line 46 of file I2cStatusEnumAc.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 54 of file I2cStatusEnumAc.hpp.

T

enum Drv::I2cStatus::T

The raw enum type.

Enumerator
I2C_OK	Transaction okay.
I2C_ADDRESS_ERR	I2C address invalid.
I2C_WRITE_ERR	I2C write failed.
I2C_READ_ERR	I2C read failed.
I2C_OPEN_ERR	I2C driver failed to open device.
I2C_OTHER_ERR	Other errors that don't fit.

Definition at line 30 of file I2cStatusEnumAc.hpp.

Constructor & Destructor Documentation

I2cStatus() [1/3]

Drv::I2cStatus::I2cStatus ( )

inline

Constructor (default value of I2C_OK)

Definition at line 68 of file I2cStatusEnumAc.hpp.

I2cStatus() [2/3]

Drv::I2cStatus::I2cStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 74 of file I2cStatusEnumAc.hpp.

I2cStatus() [3/3]

Drv::I2cStatus::I2cStatus ( const I2cStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 82 of file I2cStatusEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Drv::I2cStatus::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 I2cStatusEnumAc.cpp.

isValid()

bool Drv::I2cStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file I2cStatusEnumAc.cpp.

operator T()

Drv::I2cStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 106 of file I2cStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 118 of file I2cStatusEnumAc.hpp.

operator=() [1/2]

I2cStatus & Drv::I2cStatus::operator=

(

const I2cStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file I2cStatusEnumAc.cpp.

operator=() [2/2]

I2cStatus & Drv::I2cStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file I2cStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 112 of file I2cStatusEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Drv::I2cStatus::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 I2cStatusEnumAc.cpp.

Member Data Documentation

e

T Drv::I2cStatus::e

The raw enum value.

Definition at line 170 of file I2cStatusEnumAc.hpp.

---

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

• Drv/Ports/I2cStatusEnumAc.hpp
• Drv/Ports/I2cStatusEnumAc.cpp