F´ Flight Software - C/C++ Documentation NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Drv::PollStatus Class Reference

#include <docs-cache/F-Prime/Drv/ByteStreamDriverModel/PollStatusEnumAc.hpp>

Inheritance diagram for Drv::PollStatus:
Fw::Serializable Fw::Serializable Fw::Serializable Fw::Serializable

Public Types

enum  T {
  POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 ,
  POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 ,
  POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 3 }
 
enum  T {
  POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 ,
  POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 ,
  POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 3 }
 
enum  T {
  POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 ,
  POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 ,
  POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 3 }
 
enum  T {
  POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 ,
  POLL_RETRY = 1 , POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 ,
  POLL_ERROR = 2 , POLL_OK = 0 , POLL_RETRY = 1 , POLL_ERROR = 2
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 3 }
 
typedef I32 SerialType
 The serial representation type.
 
typedef T t
 For backwards compatibility.
 
typedef I32 SerialType
 The serial representation type.
 
typedef T t
 For backwards compatibility.
 
typedef I32 SerialType
 The serial representation type.
 
typedef T t
 For backwards compatibility.
 
typedef I32 SerialType
 The serial representation type.
 
typedef T t
 For backwards compatibility.
 

Public Member Functions

 PollStatus ()
 Constructor (default value of POLL_OK)
 
 PollStatus (const T e)
 Constructor (user-provided value)
 
 PollStatus (const PollStatus &obj)
 Copy constructor.
 
PollStatusoperator= (const PollStatus &obj)
 Copy assignment operator (object)
 
PollStatusoperator= (T e)
 Copy assignment operator (raw enum)
 
 operator T () const
 Conversion operator.
 
bool operator== (T e) const
 Equality operator.
 
bool operator!= (T e) const
 Inequality operator.
 
bool isValid () const
 Check raw enum value for validity.
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialize raw enum value to SerialType.
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialize raw enum value from SerialType.
 
 PollStatus ()
 Constructor (default value of POLL_OK)
 
 PollStatus (const T e)
 Constructor (user-provided value)
 
 PollStatus (const PollStatus &obj)
 Copy constructor.
 
PollStatusoperator= (const PollStatus &obj)
 Copy assignment operator (object)
 
PollStatusoperator= (T e)
 Copy assignment operator (raw enum)
 
 operator T () const
 Conversion operator.
 
bool operator== (T e) const
 Equality operator.
 
bool operator!= (T e) const
 Inequality operator.
 
bool isValid () const
 Check raw enum value for validity.
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialize raw enum value to SerialType.
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialize raw enum value from SerialType.
 
 PollStatus ()
 Constructor (default value of POLL_OK)
 
 PollStatus (const T e)
 Constructor (user-provided value)
 
 PollStatus (const PollStatus &obj)
 Copy constructor.
 
PollStatusoperator= (const PollStatus &obj)
 Copy assignment operator (object)
 
PollStatusoperator= (T e)
 Copy assignment operator (raw enum)
 
 operator T () const
 Conversion operator.
 
bool operator== (T e) const
 Equality operator.
 
bool operator!= (T e) const
 Inequality operator.
 
bool isValid () const
 Check raw enum value for validity.
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialize raw enum value to SerialType.
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialize raw enum value from SerialType.
 
 PollStatus ()
 Constructor (default value of POLL_OK)
 
 PollStatus (const T e)
 Constructor (user-provided value)
 
 PollStatus (const PollStatus &obj)
 Copy constructor.
 
PollStatusoperator= (const PollStatus &obj)
 Copy assignment operator (object)
 
PollStatusoperator= (T e)
 Copy assignment operator (raw enum)
 
 operator T () const
 Conversion operator.
 
bool operator== (T e) const
 Equality operator.
 
bool operator!= (T e) const
 Inequality operator.
 
bool isValid () const
 Check raw enum value for validity.
 
Fw::SerializeStatus serialize (Fw::SerializeBufferBase &buffer) const
 Serialize raw enum value to SerialType.
 
Fw::SerializeStatus deserialize (Fw::SerializeBufferBase &buffer)
 Deserialize raw enum value from SerialType.
 

Public Attributes

T e
 The raw enum value.
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::Serializable
 Serializable ()
 Default constructor.
 
virtual ~Serializable ()
 destructor
 

Detailed Description

Definition at line 16 of file PollStatusEnumAc.hpp.

Member Typedef Documentation

◆ SerialType [1/4]

The serial representation type.

Definition at line 27 of file PollStatusEnumAc.hpp.

◆ SerialType [2/4]

The serial representation type.

Definition at line 27 of file PollStatusEnumAc.hpp.

◆ SerialType [3/4]

The serial representation type.

Definition at line 27 of file PollStatusEnumAc.hpp.

◆ SerialType [4/4]

The serial representation type.

Definition at line 27 of file PollStatusEnumAc.hpp.

◆ t [1/4]

For backwards compatibility.

Definition at line 40 of file PollStatusEnumAc.hpp.

◆ t [2/4]

For backwards compatibility.

Definition at line 40 of file PollStatusEnumAc.hpp.

◆ t [3/4]

For backwards compatibility.

Definition at line 40 of file PollStatusEnumAc.hpp.

◆ t [4/4]

For backwards compatibility.

Definition at line 40 of file PollStatusEnumAc.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 48 of file PollStatusEnumAc.hpp.

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

NUM_CONSTANTS 

The number of enumerated constants.

Definition at line 48 of file PollStatusEnumAc.hpp.

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

NUM_CONSTANTS 

The number of enumerated constants.

Definition at line 48 of file PollStatusEnumAc.hpp.

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representation.

NUM_CONSTANTS 

The number of enumerated constants.

Definition at line 48 of file PollStatusEnumAc.hpp.

◆ T [1/4]

The raw enum type.

Enumerator
POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

Definition at line 30 of file PollStatusEnumAc.hpp.

◆ T [2/4]

The raw enum type.

Enumerator
POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

Definition at line 30 of file PollStatusEnumAc.hpp.

◆ T [3/4]

The raw enum type.

Enumerator
POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

Definition at line 30 of file PollStatusEnumAc.hpp.

◆ T [4/4]

The raw enum type.

Enumerator
POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

POLL_OK 

Poll successfully received data.

POLL_RETRY 

No data available, retry later.

POLL_ERROR 

Error received when polling.

Definition at line 30 of file PollStatusEnumAc.hpp.

Constructor & Destructor Documentation

◆ PollStatus() [1/12]

Drv::PollStatus::PollStatus ( )
inline

Constructor (default value of POLL_OK)

Definition at line 62 of file PollStatusEnumAc.hpp.

◆ PollStatus() [2/12]

Drv::PollStatus::PollStatus ( const T e)
inline

Constructor (user-provided value)

Parameters
eThe raw enum value

Definition at line 68 of file PollStatusEnumAc.hpp.

◆ PollStatus() [3/12]

Drv::PollStatus::PollStatus ( const PollStatus & obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 76 of file PollStatusEnumAc.hpp.

◆ PollStatus() [4/12]

Drv::PollStatus::PollStatus ( )
inline

Constructor (default value of POLL_OK)

Definition at line 62 of file PollStatusEnumAc.hpp.

◆ PollStatus() [5/12]

Drv::PollStatus::PollStatus ( const T e)
inline

Constructor (user-provided value)

Parameters
eThe raw enum value

Definition at line 68 of file PollStatusEnumAc.hpp.

◆ PollStatus() [6/12]

Drv::PollStatus::PollStatus ( const PollStatus & obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 76 of file PollStatusEnumAc.hpp.

◆ PollStatus() [7/12]

Drv::PollStatus::PollStatus ( )
inline

Constructor (default value of POLL_OK)

Definition at line 62 of file PollStatusEnumAc.hpp.

◆ PollStatus() [8/12]

Drv::PollStatus::PollStatus ( const T e)
inline

Constructor (user-provided value)

Parameters
eThe raw enum value

Definition at line 68 of file PollStatusEnumAc.hpp.

◆ PollStatus() [9/12]

Drv::PollStatus::PollStatus ( const PollStatus & obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 76 of file PollStatusEnumAc.hpp.

◆ PollStatus() [10/12]

Drv::PollStatus::PollStatus ( )
inline

Constructor (default value of POLL_OK)

Definition at line 62 of file PollStatusEnumAc.hpp.

◆ PollStatus() [11/12]

Drv::PollStatus::PollStatus ( const T e)
inline

Constructor (user-provided value)

Parameters
eThe raw enum value

Definition at line 68 of file PollStatusEnumAc.hpp.

◆ PollStatus() [12/12]

Drv::PollStatus::PollStatus ( const PollStatus & obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 76 of file PollStatusEnumAc.hpp.

Member Function Documentation

◆ deserialize() [1/4]

Fw::SerializeStatus Drv::PollStatus::deserialize ( Fw::SerializeBufferBase & buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file PollStatusEnumAc.cpp.

◆ deserialize() [2/4]

Fw::SerializeStatus Drv::PollStatus::deserialize ( Fw::SerializeBufferBase & buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

◆ deserialize() [3/4]

Fw::SerializeStatus Drv::PollStatus::deserialize ( Fw::SerializeBufferBase & buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

◆ deserialize() [4/4]

Fw::SerializeStatus Drv::PollStatus::deserialize ( Fw::SerializeBufferBase & buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

◆ isValid() [1/4]

bool Drv::PollStatus::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file PollStatusEnumAc.cpp.

◆ isValid() [2/4]

bool Drv::PollStatus::isValid ( ) const

Check raw enum value for validity.

◆ isValid() [3/4]

bool Drv::PollStatus::isValid ( ) const

Check raw enum value for validity.

◆ isValid() [4/4]

bool Drv::PollStatus::isValid ( ) const

Check raw enum value for validity.

◆ operator T() [1/4]

Drv::PollStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 100 of file PollStatusEnumAc.hpp.

◆ operator T() [2/4]

Drv::PollStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 100 of file PollStatusEnumAc.hpp.

◆ operator T() [3/4]

Drv::PollStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 100 of file PollStatusEnumAc.hpp.

◆ operator T() [4/4]

Drv::PollStatus::operator T ( ) const
inline

Conversion operator.

Definition at line 100 of file PollStatusEnumAc.hpp.

◆ operator!=() [1/4]

bool Drv::PollStatus::operator!= ( T e) const
inline

Inequality operator.

Definition at line 112 of file PollStatusEnumAc.hpp.

◆ operator!=() [2/4]

bool Drv::PollStatus::operator!= ( T e) const
inline

Inequality operator.

Definition at line 112 of file PollStatusEnumAc.hpp.

◆ operator!=() [3/4]

bool Drv::PollStatus::operator!= ( T e) const
inline

Inequality operator.

Definition at line 112 of file PollStatusEnumAc.hpp.

◆ operator!=() [4/4]

bool Drv::PollStatus::operator!= ( T e) const
inline

Inequality operator.

Definition at line 112 of file PollStatusEnumAc.hpp.

◆ operator=() [1/8]

PollStatus & Drv::PollStatus::operator= ( const PollStatus & obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file PollStatusEnumAc.cpp.

◆ operator=() [2/8]

PollStatus & Drv::PollStatus::operator= ( const PollStatus & obj)

Copy assignment operator (object)

Parameters
objThe source object

◆ operator=() [3/8]

PollStatus & Drv::PollStatus::operator= ( const PollStatus & obj)

Copy assignment operator (object)

Parameters
objThe source object

◆ operator=() [4/8]

PollStatus & Drv::PollStatus::operator= ( const PollStatus & obj)

Copy assignment operator (object)

Parameters
objThe source object

◆ operator=() [5/8]

PollStatus & Drv::PollStatus::operator= ( T e)

Copy assignment operator (raw enum)

Parameters
eThe enum value

Definition at line 26 of file PollStatusEnumAc.cpp.

◆ operator=() [6/8]

PollStatus & Drv::PollStatus::operator= ( T e)

Copy assignment operator (raw enum)

Parameters
eThe enum value

◆ operator=() [7/8]

PollStatus & Drv::PollStatus::operator= ( T e)

Copy assignment operator (raw enum)

Parameters
eThe enum value

◆ operator=() [8/8]

PollStatus & Drv::PollStatus::operator= ( T e)

Copy assignment operator (raw enum)

Parameters
eThe enum value

◆ operator==() [1/4]

bool Drv::PollStatus::operator== ( T e) const
inline

Equality operator.

Definition at line 106 of file PollStatusEnumAc.hpp.

◆ operator==() [2/4]

bool Drv::PollStatus::operator== ( T e) const
inline

Equality operator.

Definition at line 106 of file PollStatusEnumAc.hpp.

◆ operator==() [3/4]

bool Drv::PollStatus::operator== ( T e) const
inline

Equality operator.

Definition at line 106 of file PollStatusEnumAc.hpp.

◆ operator==() [4/4]

bool Drv::PollStatus::operator== ( T e) const
inline

Equality operator.

Definition at line 106 of file PollStatusEnumAc.hpp.

◆ serialize() [1/4]

Fw::SerializeStatus Drv::PollStatus::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 PollStatusEnumAc.cpp.

◆ serialize() [2/4]

Fw::SerializeStatus Drv::PollStatus::serialize ( Fw::SerializeBufferBase & buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

◆ serialize() [3/4]

Fw::SerializeStatus Drv::PollStatus::serialize ( Fw::SerializeBufferBase & buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

◆ serialize() [4/4]

Fw::SerializeStatus Drv::PollStatus::serialize ( Fw::SerializeBufferBase & buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Member Data Documentation

◆ e

T Drv::PollStatus::e

The raw enum value.

Definition at line 162 of file PollStatusEnumAc.hpp.


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