Svc::FileDispatcherCfg::FileDispatchPort Class Reference

#include <default/config/FileDispatchPortEnumAc.hpp>

Inheritance diagram for Svc::FileDispatcherCfg::FileDispatchPort:

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

An enumeration that maps file types to ports in the FileDispatcher component. Projects can add custom dispatcher ports by extending this enumeration.

Definition at line 20 of file FileDispatchPortEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef U8 Svc::FileDispatcherCfg::FileDispatchPort::SerialType

The serial representation type.

Definition at line 31 of file FileDispatchPortEnumAc.hpp.

t

typedef enum T Svc::FileDispatcherCfg::FileDispatchPort::t

For backwards compatibility.

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

T

enum Svc::FileDispatcherCfg::FileDispatchPort::T

The raw enum type.

Enumerator
SEQUENCE_FILE_PORT	Sequence file port.
BUNDLE_FILE_PORT	Bundle file port.
USER_FILE_PORT	User file port (make up your own file types starting here)
MAX_FILE_DISPATCH_PORTS	Maximum number of file dispatch ports.

Definition at line 34 of file FileDispatchPortEnumAc.hpp.

Constructor & Destructor Documentation

FileDispatchPort() [1/3]

Svc::FileDispatcherCfg::FileDispatchPort::FileDispatchPort ( )

inline

Constructor (default value of SEQUENCE_FILE_PORT)

Definition at line 68 of file FileDispatchPortEnumAc.hpp.

FileDispatchPort() [2/3]

Svc::FileDispatcherCfg::FileDispatchPort::FileDispatchPort ( const enum T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 74 of file FileDispatchPortEnumAc.hpp.

FileDispatchPort() [3/3]

Svc::FileDispatcherCfg::FileDispatchPort::FileDispatchPort ( const FileDispatchPort &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 82 of file FileDispatchPortEnumAc.hpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::FileDispatcherCfg::FileDispatchPort::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 FileDispatchPortEnumAc.cpp.

isValid()

bool Svc::FileDispatcherCfg::FileDispatchPort::isValid

(

)

const

Check raw enum value for validity.

Definition at line 51 of file FileDispatchPortEnumAc.cpp.

operator enum T()

Svc::FileDispatcherCfg::FileDispatchPort::operator enum T ( ) const

inline

Conversion operator.

Definition at line 106 of file FileDispatchPortEnumAc.hpp.

operator!=()

bool Svc::FileDispatcherCfg::FileDispatchPort::operator!= ( enum T  e1 ) const

inline

Inequality operator.

Definition at line 118 of file FileDispatchPortEnumAc.hpp.

operator=() [1/2]

FileDispatchPort & Svc::FileDispatcherCfg::FileDispatchPort::operator=

(

const FileDispatchPort &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 22 of file FileDispatchPortEnumAc.cpp.

operator=() [2/2]

FileDispatchPort & Svc::FileDispatcherCfg::FileDispatchPort::operator=

(

enum T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 29 of file FileDispatchPortEnumAc.cpp.

operator==()

bool Svc::FileDispatcherCfg::FileDispatchPort::operator== ( enum T  e1 ) const

inline

Equality operator.

Definition at line 112 of file FileDispatchPortEnumAc.hpp.

serializeTo()

Fw::SerializeStatus Svc::FileDispatcherCfg::FileDispatchPort::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 FileDispatchPortEnumAc.cpp.

Member Data Documentation

e

enum T Svc::FileDispatcherCfg::FileDispatchPort::e

The raw enum value.

Definition at line 170 of file FileDispatchPortEnumAc.hpp.

---

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

• default/config/FileDispatchPortEnumAc.hpp
• default/config/FileDispatchPortEnumAc.cpp