Svc::Fpy::FlagId Class Reference

#include <Svc/FpySequencer/FlagIdEnumAc.hpp>

Inheritance diagram for Svc::Fpy::FlagId:

Public Types
enum	T { EXIT_ON_CMD_FAIL = 0 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 1 }
typedef U8	SerialType
	The serial representation type. More...
typedef enum T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	FlagId ()
	Constructor (default value of EXIT_ON_CMD_FAIL) More...
	FlagId (const enum T e1)
	Constructor (user-provided value) More...
	FlagId (const FlagId &obj)
	Copy constructor. More...
FlagId &	operator= (const FlagId &obj)
	Copy assignment operator (object) More...
FlagId &	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")

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 18 of file FlagIdEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Svc::Fpy::FlagId::SerialType

The serial representation type.

Definition at line 29 of file FlagIdEnumAc.hpp.

t

typedef enum T Svc::Fpy::FlagId::t

For backwards compatibility.

Definition at line 38 of file FlagIdEnumAc.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 46 of file FlagIdEnumAc.hpp.

T

enum Svc::Fpy::FlagId::T

The raw enum type.

Enumerator
EXIT_ON_CMD_FAIL	if true, the sequence will exit with an error if a command fails

Definition at line 32 of file FlagIdEnumAc.hpp.

Constructor & Destructor Documentation

FlagId() [1/3]

Svc::Fpy::FlagId::FlagId ( )

inline

Constructor (default value of EXIT_ON_CMD_FAIL)

Definition at line 60 of file FlagIdEnumAc.hpp.

FlagId() [2/3]

Svc::Fpy::FlagId::FlagId ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 66 of file FlagIdEnumAc.hpp.

FlagId() [3/3]

Svc::Fpy::FlagId::FlagId ( const FlagId &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 74 of file FlagIdEnumAc.hpp.

Member Function Documentation

deserializeFrom()

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

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 70 of file FlagIdEnumAc.cpp.

isValid()

bool Svc::Fpy::FlagId::isValid

(

)

const

Check raw enum value for validity.

Definition at line 51 of file FlagIdEnumAc.cpp.

operator enum T()

Svc::Fpy::FlagId::operator enum T ( ) const

inline

Conversion operator.

Definition at line 98 of file FlagIdEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 110 of file FlagIdEnumAc.hpp.

operator=() [1/2]

FlagId & Svc::Fpy::FlagId::operator=

(

const FlagId &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file FlagIdEnumAc.cpp.

operator=() [2/2]

FlagId & Svc::Fpy::FlagId::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file FlagIdEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 104 of file FlagIdEnumAc.hpp.

serializeTo()

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

virtual

Serialize raw enum value to SerialType.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 57 of file FlagIdEnumAc.cpp.

Member Data Documentation

e

enum T Svc::Fpy::FlagId::e

The raw enum value.

Definition at line 162 of file FlagIdEnumAc.hpp.

---

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

• Svc/FpySequencer/FlagIdEnumAc.hpp
• Svc/FpySequencer/FlagIdEnumAc.cpp