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
Fw::Active Class Reference

Active and inactive states. More...

#include <docs-cache/F-Prime/Fw/Types/ActiveEnumAc.hpp>

Inheritance diagram for Fw::Active:
Fw::Serializable

Public Types

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

Public Member Functions

 Active ()
 Constructor (default value of INACTIVE)
 
 Active (const T e)
 Constructor (user-provided value)
 
 Active (const Active &obj)
 Copy constructor.
 
Activeoperator= (const Active &obj)
 Copy assignment operator (object)
 
Activeoperator= (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

Active and inactive states.

Definition at line 17 of file ActiveEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 28 of file ActiveEnumAc.hpp.

◆ t

typedef T Fw::Active::t

For backwards compatibility.

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

◆ T

The raw enum type.

Enumerator
INACTIVE 

Inactive state.

ACTIVE 

Active state.

Definition at line 31 of file ActiveEnumAc.hpp.

Constructor & Destructor Documentation

◆ Active() [1/3]

Fw::Active::Active ( )
inline

Constructor (default value of INACTIVE)

Definition at line 61 of file ActiveEnumAc.hpp.

◆ Active() [2/3]

Fw::Active::Active ( const T e)
inline

Constructor (user-provided value)

Parameters
eThe raw enum value

Definition at line 67 of file ActiveEnumAc.hpp.

◆ Active() [3/3]

Fw::Active::Active ( const Active & obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 75 of file ActiveEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Fw::Active::deserialize ( Fw::SerializeBufferBase & buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 63 of file ActiveEnumAc.cpp.

◆ isValid()

bool Fw::Active::isValid ( ) const

Check raw enum value for validity.

Definition at line 48 of file ActiveEnumAc.cpp.

◆ operator T()

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

Conversion operator.

Definition at line 99 of file ActiveEnumAc.hpp.

◆ operator!=()

bool Fw::Active::operator!= ( T e) const
inline

Inequality operator.

Definition at line 111 of file ActiveEnumAc.hpp.

◆ operator=() [1/2]

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

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 19 of file ActiveEnumAc.cpp.

◆ operator=() [2/2]

Active & Fw::Active::operator= ( T e)

Copy assignment operator (raw enum)

Parameters
eThe enum value

Definition at line 26 of file ActiveEnumAc.cpp.

◆ operator==()

bool Fw::Active::operator== ( T e) const
inline

Equality operator.

Definition at line 105 of file ActiveEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Fw::Active::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 ActiveEnumAc.cpp.

Member Data Documentation

◆ e

T Fw::Active::e

The raw enum value.

Definition at line 161 of file ActiveEnumAc.hpp.


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