Fw::Success Class Reference

Success/Failure. More...

#include <Fw/Types/SuccessEnumAc.hpp>

Inheritance diagram for Fw::Success:

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

Success/Failure.

Definition at line 17 of file SuccessEnumAc.hpp.

Member Typedef Documentation

SerialType

typedef I32 Fw::Success::SerialType

The serial representation type.

Definition at line 28 of file SuccessEnumAc.hpp.

t

typedef T Fw::Success::t

For backwards compatibility.

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

T

enum Fw::Success::T

The raw enum type.

Enumerator
FAILURE	Representing failure.
SUCCESS	Representing success.

Definition at line 31 of file SuccessEnumAc.hpp.

Constructor & Destructor Documentation

Success() [1/3]

Fw::Success::Success ( )

inline

Constructor (default value of FAILURE)

Definition at line 61 of file SuccessEnumAc.hpp.

Success() [2/3]

Fw::Success::Success ( const T  e1 )

inline

Constructor (user-provided value)

Parameters

e1	The raw enum value

Definition at line 67 of file SuccessEnumAc.hpp.

Success() [3/3]

Fw::Success::Success ( const Success &  obj )

inline

Copy constructor.

Parameters

obj	The source object

Definition at line 75 of file SuccessEnumAc.hpp.

Member Function Documentation

deserialize()

Fw::SerializeStatus Fw::Success::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 SuccessEnumAc.cpp.

isValid()

bool Fw::Success::isValid

(

)

const

Check raw enum value for validity.

Definition at line 48 of file SuccessEnumAc.cpp.

operator T()

Fw::Success::operator T ( ) const

inline

Conversion operator.

Definition at line 99 of file SuccessEnumAc.hpp.

operator!=()

bool Fw::Success::operator!= ( T  e1 ) const

inline

Inequality operator.

Definition at line 111 of file SuccessEnumAc.hpp.

operator=() [1/2]

Success & Fw::Success::operator=

(

const Success &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 19 of file SuccessEnumAc.cpp.

operator=() [2/2]

Success & Fw::Success::operator=

(

T

e1

)

Copy assignment operator (raw enum)

Parameters

e1	The enum value

Definition at line 26 of file SuccessEnumAc.cpp.

operator==()

bool Fw::Success::operator== ( T  e1 ) const

inline

Equality operator.

Definition at line 105 of file SuccessEnumAc.hpp.

serialize()

Fw::SerializeStatus Fw::Success::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 SuccessEnumAc.cpp.

Member Data Documentation

e

T Fw::Success::e

The raw enum value.

Definition at line 161 of file SuccessEnumAc.hpp.

---

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

• Fw/Types/SuccessEnumAc.hpp
• Fw/Types/SuccessEnumAc.cpp