Svc::SendFileStatus Class Reference

Send file status enum. More...

#include <Svc/FileDownlinkPorts/SendFileStatusEnumAc.hpp>

Inheritance diagram for Svc::SendFileStatus:

Public Types
enum	T { STATUS_OK = 0 , STATUS_ERROR = 1 , STATUS_INVALID = 2 , STATUS_BUSY = 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 = NATIVE_UINT_TYPE

Public Member Functions
	SendFileStatus ()
	Constructor (default value of STATUS_OK) More...
	SendFileStatus (const T e1)
	Constructor (user-provided value) More...
	SendFileStatus (const SendFileStatus &obj)
	Copy constructor. More...
SendFileStatus &	operator= (const SendFileStatus &obj)
	Copy assignment operator (object) More...
SendFileStatus &	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	serialize (Fw::SerializeBufferBase &buffer) const
	Serialize raw enum value to SerialType. More...
Fw::SerializeStatus	deserialize (Fw::SerializeBufferBase &buffer)
	Deserialize raw enum value from SerialType. More...

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

Detailed Description

Send file status enum.

Definition at line 17 of file SendFileStatusEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Svc::SendFileStatus::SerialType

The serial representation type.

Definition at line 28 of file SendFileStatusEnumAc.hpp.

t

typedef T Svc::SendFileStatus::t

For backwards compatibility.

Definition at line 39 of file SendFileStatusEnumAc.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 47 of file SendFileStatusEnumAc.hpp.

T

enum Svc::SendFileStatus::T

The raw enum type.

Enumerator
STATUS_OK
STATUS_ERROR
STATUS_INVALID
STATUS_BUSY

Definition at line 31 of file SendFileStatusEnumAc.hpp.

Constructor & Destructor Documentation

SendFileStatus() [1/3]

Svc::SendFileStatus::SendFileStatus ( )

inline

Constructor (default value of STATUS_OK)

Definition at line 61 of file SendFileStatusEnumAc.hpp.

SendFileStatus() [2/3]

Svc::SendFileStatus::SendFileStatus ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 67 of file SendFileStatusEnumAc.hpp.

SendFileStatus() [3/3]

Svc::SendFileStatus::SendFileStatus ( const SendFileStatus &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 75 of file SendFileStatusEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Svc::SendFileStatus::deserialize ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialize raw enum value from SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 63 of file SendFileStatusEnumAc.cpp.

isValid()

bool Svc::SendFileStatus::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file SendFileStatusEnumAc.cpp.

operator T()

Svc::SendFileStatus::operator T ( ) const

inline

Conversion operator.

Definition at line 99 of file SendFileStatusEnumAc.hpp.

operator!=()

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

inline

Inequality operator.

Definition at line 111 of file SendFileStatusEnumAc.hpp.

operator=() [1/2]

SendFileStatus & Svc::SendFileStatus::operator=

(

const SendFileStatus &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file SendFileStatusEnumAc.cpp.

operator=() [2/2]

SendFileStatus & Svc::SendFileStatus::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file SendFileStatusEnumAc.cpp.

operator==()

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

inline

Equality operator.

Definition at line 105 of file SendFileStatusEnumAc.hpp.

serialize()

Fw::SerializeStatus Svc::SendFileStatus::serialize ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialize raw enum value to SerialType.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 54 of file SendFileStatusEnumAc.cpp.

Member Data Documentation

e

T Svc::SendFileStatus::e

The raw enum value.

Definition at line 161 of file SendFileStatusEnumAc.hpp.

---

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

• Svc/FileDownlinkPorts/SendFileStatusEnumAc.hpp
• Svc/FileDownlinkPorts/SendFileStatusEnumAc.cpp