F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Svc::Fpy::DirectiveId Class Reference

#include <Svc/FpySequencer/DirectiveIdEnumAc.hpp>

Inheritance diagram for Svc::Fpy::DirectiveId:
Fw::Serializable

Public Types

enum  T {
  INVALID = 0, WAIT_REL = 1, WAIT_ABS = 2, GOTO = 3,
  IF = 4, NO_OP = 5, PUSH_TLM_VAL = 6, PUSH_PRM = 7,
  CONST_CMD = 8, OR = 9, AND = 10, IEQ = 11,
  INE = 12, ULT = 13, ULE = 14, UGT = 15,
  UGE = 16, SLT = 17, SLE = 18, SGT = 19,
  SGE = 20, FEQ = 21, FNE = 22, FLT = 23,
  FLE = 24, FGT = 25, FGE = 26, NOT = 27,
  FPTOSI = 28, FPTOUI = 29, SITOFP = 30, UITOFP = 31,
  ADD = 32, SUB = 33, MUL = 34, UDIV = 35,
  SDIV = 36, UMOD = 37, SMOD = 38, FADD = 39,
  FSUB = 40, FMUL = 41, FDIV = 42, FPOW = 43,
  FLOG = 44, FMOD = 45, FPEXT = 46, FPTRUNC = 47,
  SIEXT_8_64 = 48, SIEXT_16_64 = 49, SIEXT_32_64 = 50, ZIEXT_8_64 = 51,
  ZIEXT_16_64 = 52, ZIEXT_32_64 = 53, ITRUNC_64_8 = 54, ITRUNC_64_16 = 55,
  ITRUNC_64_32 = 56, EXIT = 57, ALLOCATE = 58, STORE_REL_CONST_OFFSET = 59,
  LOAD_REL = 60, PUSH_VAL = 61, DISCARD = 62, MEMCMP = 63,
  STACK_CMD = 64, PUSH_TLM_VAL_AND_TIME = 65, PUSH_TIME = 66, GET_FIELD = 67,
  PEEK = 68, STORE_REL = 69, CALL = 70, RETURN = 71,
  LOAD_ABS = 72, STORE_ABS = 73, STORE_ABS_CONST_OFFSET = 74, POP_EVENT = 75,
  SET_SEED = 76, PUSH_RAND = 77, POP_SERIALIZABLE = 78, FFLOOR = 79,
  IABS = 80, FABS = 81
}
 The raw enum type. More...
 
enum  { SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 82 }
 
using SerialType = U8
 The serial representation type. More...
 
using t = enum T
 For backwards compatibility. More...
 
- Public Types inherited from Fw::Serializable
using SizeType = FwSizeType
 

Public Member Functions

 DirectiveId ()
 Constructor (default value of INVALID) More...
 
 DirectiveId (const enum T e1)
 Constructor (user-provided value) More...
 
 DirectiveId (const SerialType e1)
 Constructor (serial representation value) More...
 
 DirectiveId (const DirectiveId &obj)
 Copy constructor. More...
 
DirectiveId & operator= (const DirectiveId &obj)
 Copy assignment operator (object) More...
 
DirectiveId & operator= (SerialType e1)
 Assignment operator (serial representation value) More...
 
DirectiveId & operator= (enum T e1)
 Copy assignment operator (raw enum) More...
 
 operator enum T () const
 Conversion operator. More...
 
bool operator== (enum T e1) const
 Equality operator. More...
 
bool operator!= (enum T e1) const
 Inequality operator. More...
 
bool isValid () const
 Check raw enum value for validity. More...
 
Fw::SerializeStatus serializeTo (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
 Serialize raw enum value to SerialType. More...
 
Fw::SerializeStatus deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
 Deserialize raw enum value from SerialType. More...
 
- Public Member Functions inherited from Fw::Serializable
 DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
 
 DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")
 

Static Public Member Functions

static bool isValid (SerialType serialTypeValue)
 Check serial type value for validity. More...
 

Public Attributes

enum T e
 The raw enum value. More...
 

Additional Inherited Members

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

Detailed Description

Definition at line 19 of file DirectiveIdEnumAc.hpp.

Member Typedef Documentation

◆ SerialType

using Svc::Fpy::DirectiveId::SerialType = U8

The serial representation type.

Definition at line 30 of file DirectiveIdEnumAc.hpp.

◆ t

using Svc::Fpy::DirectiveId::t = enum T

For backwards compatibility.

Definition at line 119 of file DirectiveIdEnumAc.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 127 of file DirectiveIdEnumAc.hpp.

◆ T

enum Svc::Fpy::DirectiveId::T

The raw enum type.

Enumerator
INVALID 
WAIT_REL 
WAIT_ABS 
GOTO 
IF 
NO_OP 
PUSH_TLM_VAL 
PUSH_PRM 
CONST_CMD 
OR 
AND 
IEQ 
INE 
ULT 
ULE 
UGT 
UGE 
SLT 
SLE 
SGT 
SGE 
FEQ 
FNE 
FLT 
FLE 
FGT 
FGE 
NOT 
FPTOSI 
FPTOUI 
SITOFP 
UITOFP 
ADD 
SUB 
MUL 
UDIV 
SDIV 
UMOD 
SMOD 
FADD 
FSUB 
FMUL 
FDIV 
FPOW 
FLOG 
FMOD 
FPEXT 
FPTRUNC 
SIEXT_8_64 
SIEXT_16_64 
SIEXT_32_64 
ZIEXT_8_64 
ZIEXT_16_64 
ZIEXT_32_64 
ITRUNC_64_8 
ITRUNC_64_16 
ITRUNC_64_32 
EXIT 
ALLOCATE 
STORE_REL_CONST_OFFSET 
LOAD_REL 
PUSH_VAL 
DISCARD 
MEMCMP 
STACK_CMD 
PUSH_TLM_VAL_AND_TIME 
PUSH_TIME 
GET_FIELD 
PEEK 
STORE_REL 
CALL 
RETURN 
LOAD_ABS 
STORE_ABS 
STORE_ABS_CONST_OFFSET 
POP_EVENT 
SET_SEED 
PUSH_RAND 
POP_SERIALIZABLE 
FFLOOR 
IABS 
FABS 

Definition at line 33 of file DirectiveIdEnumAc.hpp.

Constructor & Destructor Documentation

◆ DirectiveId() [1/4]

Svc::Fpy::DirectiveId::DirectiveId ( )
inline

Constructor (default value of INVALID)

Definition at line 141 of file DirectiveIdEnumAc.hpp.

◆ DirectiveId() [2/4]

Svc::Fpy::DirectiveId::DirectiveId ( const enum T  e1)
inline

Constructor (user-provided value)

Parameters
e1The raw enum value

Definition at line 147 of file DirectiveIdEnumAc.hpp.

◆ DirectiveId() [3/4]

Svc::Fpy::DirectiveId::DirectiveId ( const SerialType  e1)
inline

Constructor (serial representation value)

Parameters
e1The serial representation value

Definition at line 156 of file DirectiveIdEnumAc.hpp.

◆ DirectiveId() [4/4]

Svc::Fpy::DirectiveId::DirectiveId ( const DirectiveId &  obj)
inline

Copy constructor.

Parameters
objThe source object

Definition at line 165 of file DirectiveIdEnumAc.hpp.

Member Function Documentation

◆ deserializeFrom()

Fw::SerializeStatus Svc::Fpy::DirectiveId::deserializeFrom ( Fw::SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
)
virtual

Deserialize raw enum value from SerialType.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 95 of file DirectiveIdEnumAc.cpp.

◆ isValid() [1/2]

bool Svc::Fpy::DirectiveId::isValid ( ) const

Check raw enum value for validity.

Definition at line 71 of file DirectiveIdEnumAc.cpp.

◆ isValid() [2/2]

bool Svc::Fpy::DirectiveId::isValid ( SerialType  serialTypeValue)
static

Check serial type value for validity.

Parameters
serialTypeValueThe serial type value

Definition at line 389 of file DirectiveIdEnumAc.cpp.

◆ operator enum T()

Svc::Fpy::DirectiveId::operator enum T ( ) const
inline

Conversion operator.

Definition at line 198 of file DirectiveIdEnumAc.hpp.

◆ operator!=()

bool Svc::Fpy::DirectiveId::operator!= ( enum T  e1) const
inline

Inequality operator.

Definition at line 210 of file DirectiveIdEnumAc.hpp.

◆ operator=() [1/3]

DirectiveId & Svc::Fpy::DirectiveId::operator= ( const DirectiveId &  obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 21 of file DirectiveIdEnumAc.cpp.

◆ operator=() [2/3]

DirectiveId & Svc::Fpy::DirectiveId::operator= ( SerialType  e1)

Assignment operator (serial representation value)

Parameters
e1The serial representation value

Definition at line 32 of file DirectiveIdEnumAc.cpp.

◆ operator=() [3/3]

DirectiveId & Svc::Fpy::DirectiveId::operator= ( enum T  e1)

Copy assignment operator (raw enum)

Parameters
e1The enum value

Definition at line 44 of file DirectiveIdEnumAc.cpp.

◆ operator==()

bool Svc::Fpy::DirectiveId::operator== ( enum T  e1) const
inline

Equality operator.

Definition at line 204 of file DirectiveIdEnumAc.hpp.

◆ serializeTo()

Fw::SerializeStatus Svc::Fpy::DirectiveId::serializeTo ( Fw::SerialBufferBase &  buffer,
Fw::Endianness  mode = Fw::Endianness::BIG 
) const
virtual

Serialize raw enum value to SerialType.

Parameters
bufferThe serial buffer
modeEndianness of serialized buffer

Implements Fw::Serializable.

Definition at line 77 of file DirectiveIdEnumAc.cpp.

Member Data Documentation

◆ e

enum T Svc::Fpy::DirectiveId::e

The raw enum value.

Definition at line 282 of file DirectiveIdEnumAc.hpp.

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