F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Drv::I2cStatus Class Reference

#include <Drv/Ports/I2cStatusEnumAc.hpp>

Inheritance diagram for Drv::I2cStatus:
Fw::Serializable

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 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

 I2cStatus ()
 Constructor (default value of I2C_OK) More...
 
 I2cStatus (const T e1)
 Constructor (user-provided value) More...
 
 I2cStatus (const I2cStatus &obj)
 Copy constructor. More...
 
I2cStatusoperator= (const I2cStatus &obj)
 Copy assignment operator (object) More...
 
I2cStatusoperator= (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 I2cStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 27 of file I2cStatusEnumAc.hpp.

◆ 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

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
e1The raw enum value

Definition at line 74 of file I2cStatusEnumAc.hpp.

◆ I2cStatus() [3/3]

Drv::I2cStatus::I2cStatus ( const I2cStatus obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 82 of file I2cStatusEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Drv::I2cStatus::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file I2cStatusEnumAc.cpp.

◆ isValid()

bool Drv::I2cStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 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
objThe source object

Definition at line 19 of file I2cStatusEnumAc.cpp.

◆ operator=() [2/2]

I2cStatus & Drv::I2cStatus::operator= ( T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 26 of file I2cStatusEnumAc.cpp.

◆ operator==()

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

Equality operator.

Definition at line 112 of file I2cStatusEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Drv::I2cStatus::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 54 of file I2cStatusEnumAc.cpp.

Member Data Documentation

◆ e

T Drv::I2cStatus::e

The raw enum value.

Definition at line 168 of file I2cStatusEnumAc.hpp.


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