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

Enabled and disabled states. More...

#include <Fw/Types/EnabledEnumAc.hpp>

Inheritance diagram for Fw::Enabled:
Fw::Serializable

Public Types

enum  T { DISABLED = 0 , ENABLED = 1 }
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 2 }
 
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

 Enabled ()
 Constructor (default value of DISABLED) More...
 
 Enabled (const T e1)
 Constructor (user-provided value) More...
 
 Enabled (const Enabled &obj)
 Copy constructor. More...
 
Enabledoperator= (const Enabled &obj)
 Copy assignment operator (object) More...
 
Enabledoperator= (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

Enabled and disabled states.

Definition at line 17 of file EnabledEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file EnabledEnumAc.hpp.

◆ t

typedef T Fw::Enabled::t

For backwards compatibility.

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

◆ T

The raw enum type.

Enumerator
DISABLED 

Disabled state.

ENABLED 

Enabled state.

Definition at line 31 of file EnabledEnumAc.hpp.

Constructor & Destructor Documentation

◆ Enabled() [1/3]

Fw::Enabled::Enabled ( )
inline

Constructor (default value of DISABLED)

Definition at line 61 of file EnabledEnumAc.hpp.

◆ Enabled() [2/3]

Fw::Enabled::Enabled ( const T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 67 of file EnabledEnumAc.hpp.

◆ Enabled() [3/3]

Fw::Enabled::Enabled ( const Enabled obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 75 of file EnabledEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Fw::Enabled::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file EnabledEnumAc.cpp.

◆ isValid()

bool Fw::Enabled::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file EnabledEnumAc.cpp.

◆ operator T()

Fw::Enabled::operator T ( ) const
inline

Conversion operator.

Definition at line 99 of file EnabledEnumAc.hpp.

◆ operator!=()

bool Fw::Enabled::operator!= ( T  e1) const
inline

Inequality operator.

Definition at line 111 of file EnabledEnumAc.hpp.

◆ operator=() [1/2]

Enabled & Fw::Enabled::operator= ( const Enabled obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file EnabledEnumAc.cpp.

◆ operator=() [2/2]

Enabled & Fw::Enabled::operator= ( T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 26 of file EnabledEnumAc.cpp.

◆ operator==()

bool Fw::Enabled::operator== ( T  e1) const
inline

Equality operator.

Definition at line 105 of file EnabledEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Fw::Enabled::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 EnabledEnumAc.cpp.

Member Data Documentation

◆ e

T Fw::Enabled::e

The raw enum value.

Definition at line 161 of file EnabledEnumAc.hpp.


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