Svc::TelemetrySection Class Reference

#include <default/config/TelemetrySectionEnumAc.hpp>

Inheritance diagram for Svc::TelemetrySection:

Public Types
enum	T { PRIMARY = 0, SECONDARY = 1, TERTIARY = 2, NUM_SECTIONS = 3 }
	The raw enum type. More...
enum	{ SERIALIZED_SIZE = sizeof(SerialType), NUM_CONSTANTS = 4 }
typedef I32	SerialType
	The serial representation type. More...
typedef T	t
	For backwards compatibility. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	TelemetrySection ()
	Constructor (default value of PRIMARY) More...
	TelemetrySection (const T e1)
	Constructor (user-provided value) More...
	TelemetrySection (const TelemetrySection &obj)
	Copy constructor. More...
TelemetrySection &	operator= (const TelemetrySection &obj)
	Copy assignment operator (object) More...
TelemetrySection &	operator= (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	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
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

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 ()
	Virtual destructor. More...

Detailed Description

Configurable enum supporting multiple resampled telemetry sections Each section creates output indices for each telemetry group

Definition at line 18 of file TelemetrySectionEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Svc::TelemetrySection::SerialType

The serial representation type.

Definition at line 29 of file TelemetrySectionEnumAc.hpp.

t

typedef T Svc::TelemetrySection::t

For backwards compatibility.

Definition at line 41 of file TelemetrySectionEnumAc.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 49 of file TelemetrySectionEnumAc.hpp.

T

enum Svc::TelemetrySection::T

The raw enum type.

Enumerator
PRIMARY
SECONDARY
TERTIARY
NUM_SECTIONS	REQUIRED: Counter, leave as last element.

Definition at line 32 of file TelemetrySectionEnumAc.hpp.

Constructor & Destructor Documentation

TelemetrySection() [1/3]

Svc::TelemetrySection::TelemetrySection ( )

inline

Constructor (default value of PRIMARY)

Definition at line 63 of file TelemetrySectionEnumAc.hpp.

TelemetrySection() [2/3]

Svc::TelemetrySection::TelemetrySection ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 69 of file TelemetrySectionEnumAc.hpp.

TelemetrySection() [3/3]

Svc::TelemetrySection::TelemetrySection ( const TelemetrySection &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 77 of file TelemetrySectionEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::TelemetrySection::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 68 of file TelemetrySectionEnumAc.cpp.

isValid()

bool Svc::TelemetrySection::isValid

(

)

const

Check raw enum value for validity.

Definition at line 49 of file TelemetrySectionEnumAc.cpp.

operator T()

Svc::TelemetrySection::operator T ( ) const

inline

Conversion operator.

Definition at line 101 of file TelemetrySectionEnumAc.hpp.

operator!=()

bool Svc::TelemetrySection::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 113 of file TelemetrySectionEnumAc.hpp.

operator=() [1/2]

TelemetrySection & Svc::TelemetrySection::operator=

(

const TelemetrySection &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 20 of file TelemetrySectionEnumAc.cpp.

operator=() [2/2]

TelemetrySection & Svc::TelemetrySection::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 27 of file TelemetrySectionEnumAc.cpp.

operator==()

bool Svc::TelemetrySection::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 107 of file TelemetrySectionEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Svc::TelemetrySection::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 55 of file TelemetrySectionEnumAc.cpp.

Member Data Documentation

e

T Svc::TelemetrySection::e

The raw enum value.

Definition at line 165 of file TelemetrySectionEnumAc.hpp.

---

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

• default/config/TelemetrySectionEnumAc.hpp
• default/config/TelemetrySectionEnumAc.cpp