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

#include <config/PolyDbEntryEnumAc.hpp>

Inheritance diagram for Svc::PolyDbCfg::PolyDbEntry:
Fw::Serializable

Public Types

enum  T {
  POLYDB_ENTRY_00 = 0 , POLYDB_ENTRY_01 = 1 , POLYDB_ENTRY_03 = 2 , POLYDB_ENTRY_04 = 3 ,
  POLYDB_ENTRY_05 = 4 , POLYDB_ENTRY_06 = 5 , POLYDB_ENTRY_07 = 6 , POLYDB_ENTRY_08 = 7 ,
  POLYDB_ENTRY_09 = 8
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType) , NUM_CONSTANTS = 9 }
 
typedef U32 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

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

Define a set of PolyDb entries on a project-specific basis.

Definition at line 20 of file PolyDbEntryEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

The serial representation type.

Definition at line 31 of file PolyDbEntryEnumAc.hpp.

◆ t

For backwards compatibility.

Definition at line 56 of file PolyDbEntryEnumAc.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 64 of file PolyDbEntryEnumAc.hpp.

◆ T

The raw enum type.

Enumerator
POLYDB_ENTRY_00 

Entry 0.

POLYDB_ENTRY_01 

Entry 1.

POLYDB_ENTRY_03 

Entry 2.

POLYDB_ENTRY_04 

Entry 4.

POLYDB_ENTRY_05 

Entry 5.

POLYDB_ENTRY_06 

Entry 6.

POLYDB_ENTRY_07 

Entry 7.

POLYDB_ENTRY_08 

Entry 8.

POLYDB_ENTRY_09 

Entry 9.

Definition at line 34 of file PolyDbEntryEnumAc.hpp.

Constructor & Destructor Documentation

◆ PolyDbEntry() [1/3]

Svc::PolyDbCfg::PolyDbEntry::PolyDbEntry ( )
inline

Constructor (default value of POLYDB_ENTRY_00)

Definition at line 78 of file PolyDbEntryEnumAc.hpp.

◆ PolyDbEntry() [2/3]

Svc::PolyDbCfg::PolyDbEntry::PolyDbEntry ( const T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 84 of file PolyDbEntryEnumAc.hpp.

◆ PolyDbEntry() [3/3]

Svc::PolyDbCfg::PolyDbEntry::PolyDbEntry ( const PolyDbEntry obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 92 of file PolyDbEntryEnumAc.hpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Svc::PolyDbCfg::PolyDbEntry::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 65 of file PolyDbEntryEnumAc.cpp.

◆ isValid()

bool Svc::PolyDbCfg::PolyDbEntry::isValid ( ) const

Check raw enum value for validity.

Definition at line 50 of file PolyDbEntryEnumAc.cpp.

◆ operator T()

Svc::PolyDbCfg::PolyDbEntry::operator T ( ) const
inline

Conversion operator.

Definition at line 116 of file PolyDbEntryEnumAc.hpp.

◆ operator!=()

bool Svc::PolyDbCfg::PolyDbEntry::operator!= ( T  e1) const
inline

Inequality operator.

Definition at line 128 of file PolyDbEntryEnumAc.hpp.

◆ operator=() [1/2]

PolyDbEntry & Svc::PolyDbCfg::PolyDbEntry::operator= ( const PolyDbEntry obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 21 of file PolyDbEntryEnumAc.cpp.

◆ operator=() [2/2]

PolyDbEntry & Svc::PolyDbCfg::PolyDbEntry::operator= ( T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 28 of file PolyDbEntryEnumAc.cpp.

◆ operator==()

bool Svc::PolyDbCfg::PolyDbEntry::operator== ( T  e1) const
inline

Equality operator.

Definition at line 122 of file PolyDbEntryEnumAc.hpp.

◆ serialize()

Fw::SerializeStatus Svc::PolyDbCfg::PolyDbEntry::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 56 of file PolyDbEntryEnumAc.cpp.

Member Data Documentation

◆ e

T Svc::PolyDbCfg::PolyDbEntry::e

The raw enum value.

Definition at line 178 of file PolyDbEntryEnumAc.hpp.


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