Fw::DpCfg::ProcType Class Reference

#include <default/config/ProcTypeEnumAc.hpp>

Inheritance diagram for Fw::DpCfg::ProcType:

Public Types
enum	T { PROC_TYPE_ZERO = 1, PROC_TYPE_ONE = 2, PROC_TYPE_TWO = 4 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 3 }
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
	ProcType ()
	Constructor (default value of PROC_TYPE_ZERO) More...
	ProcType (const enum T e1)
	Constructor (user-provided value) More...
	ProcType (const ProcType &obj)
	Copy constructor. More...
ProcType &	operator= (const ProcType &obj)
	Copy assignment operator (object) More...
ProcType &	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

A bit mask for selecting the type of processing to perform on a container before writing it to disk.

Definition at line 20 of file ProcTypeEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Fw::DpCfg::ProcType::SerialType

The serial representation type.

Definition at line 31 of file ProcTypeEnumAc.hpp.

t

typedef enum T Fw::DpCfg::ProcType::t

For backwards compatibility.

Definition at line 44 of file ProcTypeEnumAc.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 52 of file ProcTypeEnumAc.hpp.

T

enum Fw::DpCfg::ProcType::T

The raw enum type.

Enumerator
PROC_TYPE_ZERO	Processing type 0.
PROC_TYPE_ONE	Processing type 1.
PROC_TYPE_TWO	Processing type 2.

Definition at line 34 of file ProcTypeEnumAc.hpp.

Constructor & Destructor Documentation

ProcType() [1/3]

Fw::DpCfg::ProcType::ProcType ( )

inline

Constructor (default value of PROC_TYPE_ZERO)

Definition at line 66 of file ProcTypeEnumAc.hpp.

ProcType() [2/3]

Fw::DpCfg::ProcType::ProcType ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 72 of file ProcTypeEnumAc.hpp.

ProcType() [3/3]

Fw::DpCfg::ProcType::ProcType ( const ProcType &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 80 of file ProcTypeEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Fw::DpCfg::ProcType::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 71 of file ProcTypeEnumAc.cpp.

isValid()

bool Fw::DpCfg::ProcType::isValid

(

)

const

Check raw enum value for validity.

Definition at line 51 of file ProcTypeEnumAc.cpp.

operator enum T()

Fw::DpCfg::ProcType::operator enum T ( ) const

inline

Conversion operator.

Definition at line 104 of file ProcTypeEnumAc.hpp.

operator!=()

bool Fw::DpCfg::ProcType::operator!= ( enum T  e1 ) const

inline

Inequality operator.

Definition at line 116 of file ProcTypeEnumAc.hpp.

operator=() [1/2]

ProcType & Fw::DpCfg::ProcType::operator=

(

const ProcType &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file ProcTypeEnumAc.cpp.

operator=() [2/2]

ProcType & Fw::DpCfg::ProcType::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file ProcTypeEnumAc.cpp.

operator==()

bool Fw::DpCfg::ProcType::operator== ( enum T  e1 ) const

inline

Equality operator.

Definition at line 110 of file ProcTypeEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Fw::DpCfg::ProcType::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 58 of file ProcTypeEnumAc.cpp.

Member Data Documentation

e

enum T Fw::DpCfg::ProcType::e

The raw enum value.

Definition at line 168 of file ProcTypeEnumAc.hpp.

---

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

• default/config/ProcTypeEnumAc.hpp
• default/config/ProcTypeEnumAc.cpp