Svc::ComQueueDepth Class Reference

Array of queue depths for Fw::Com types. More...

#include <Svc/ComQueue/ComQueueDepthArrayAc.hpp>

Inheritance diagram for Svc::ComQueueDepth:

Public Types
enum	{ SIZE = 2, ELEMENT_SERIALIZED_SIZE = sizeof(U32), SERIALIZED_SIZE = SIZE * ELEMENT_SERIALIZED_SIZE }
using	ElementType = U32
	The element type. More...
Public Types inherited from Fw::Serializable
using	SizeType = FwSizeType

Public Member Functions
	ComQueueDepth ()
	Constructor (default value) More...
	ComQueueDepth (const ElementType(&a)[SIZE])
	Constructor (user-provided value) More...
	ComQueueDepth (const ElementType &e)
	Constructor (single element) More...
	ComQueueDepth (const ElementType &e1, const ElementType &e2)
	Constructor (multiple elements) More...
	ComQueueDepth (const ComQueueDepth &obj)
	Copy Constructor. More...
ElementType &	operator[] (const U32 i)
	Subscript operator. More...
const ElementType &	operator[] (const U32 i) const
	Const subscript operator. More...
ComQueueDepth &	operator= (const ComQueueDepth &obj)
	Copy assignment operator (object) More...
ComQueueDepth &	operator= (const ElementType(&a)[SIZE])
	Copy assignment operator (raw array) More...
ComQueueDepth &	operator= (const ElementType &e)
	Copy assignment operator (single element) More...
bool	operator== (const ComQueueDepth &obj) const
	Equality operator. More...
bool	operator!= (const ComQueueDepth &obj) const
	Inequality operator. More...
Fw::SerializeStatus	serializeTo (Fw::SerializeBufferBase &buffer) const
	Serialization. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerializeBufferBase &buffer)
	Deserialization. More...
FwSizeType	serializedSize () const
	Get the dynamic serialized size of the array. More...
Public Member Functions inherited from Fw::Serializable
SerializeStatus	serialize (SerializeBufferBase &buffer) const
SerializeStatus	deserialize (SerializeBufferBase &buffer)

Additional Inherited Members
Protected Member Functions inherited from Fw::Serializable
	Serializable ()
	Default constructor. More...
virtual	~Serializable ()
	destructor More...

Detailed Description

Array of queue depths for Fw::Com types.

Definition at line 18 of file ComQueueDepthArrayAc.hpp.

Member Typedef Documentation

ElementType

using Svc::ComQueueDepth::ElementType = U32

The element type.

Definition at line 29 of file ComQueueDepthArrayAc.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
SIZE	The size of the array.
ELEMENT_SERIALIZED_SIZE	The serialized size of each element.
SERIALIZED_SIZE	The size of the serial representation.

Definition at line 37 of file ComQueueDepthArrayAc.hpp.

Constructor & Destructor Documentation

ComQueueDepth() [1/5]

Svc::ComQueueDepth::ComQueueDepth

(

)

Constructor (default value)

Definition at line 17 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [2/5]

Svc::ComQueueDepth::ComQueueDepth

(

const ElementType(&)

a[SIZE]

)

Constructor (user-provided value)

Parameters

a

The array

Definition at line 28 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [3/5]

Svc::ComQueueDepth::ComQueueDepth

(

const ElementType &

e

)

Constructor (single element)

Parameters

e	The element

Definition at line 37 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [4/5]

Svc::ComQueueDepth::ComQueueDepth	(	const ElementType &	e1,
		const ElementType &	e2
	)

Constructor (multiple elements)

Parameters

e1	Element 1
e2	Element 2

Definition at line 46 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [5/5]

Svc::ComQueueDepth::ComQueueDepth

(

const ComQueueDepth &

obj

)

Copy Constructor.

Parameters

obj	The source object

Definition at line 57 of file ComQueueDepthArrayAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::ComQueueDepth::deserializeFrom ( Fw::SerializeBufferBase &  buffer )

virtual

Deserialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 160 of file ComQueueDepthArrayAc.cpp.

operator!=()

bool Svc::ComQueueDepth::operator!=

(

const ComQueueDepth &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 126 of file ComQueueDepthArrayAc.cpp.

operator=() [1/3]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ComQueueDepth &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 84 of file ComQueueDepthArrayAc.cpp.

operator=() [2/3]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ElementType(&)

a[SIZE]

)

Copy assignment operator (raw array)

Parameters

a	The source array

Definition at line 97 of file ComQueueDepthArrayAc.cpp.

operator=() [3/3]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ElementType &

e

)

Copy assignment operator (single element)

Parameters

e	The element

Definition at line 106 of file ComQueueDepthArrayAc.cpp.

operator==()

bool Svc::ComQueueDepth::operator==

(

const ComQueueDepth &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 115 of file ComQueueDepthArrayAc.cpp.

operator[]() [1/2]

ComQueueDepth::ElementType & Svc::ComQueueDepth::operator[]

(

const U32

i

)

Subscript operator.

Parameters

i	The subscript index

Definition at line 70 of file ComQueueDepthArrayAc.cpp.

operator[]() [2/2]

const ComQueueDepth::ElementType & Svc::ComQueueDepth::operator[]

(

const U32

i

)

const

Const subscript operator.

Parameters

i	The subscript index

Definition at line 77 of file ComQueueDepthArrayAc.cpp.

serializedSize()

FwSizeType Svc::ComQueueDepth::serializedSize

(

)

const

Get the dynamic serialized size of the array.

Definition at line 173 of file ComQueueDepthArrayAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::ComQueueDepth::serializeTo ( Fw::SerializeBufferBase &  buffer ) const

virtual

Serialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 147 of file ComQueueDepthArrayAc.cpp.

---

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

• Svc/ComQueue/ComQueueDepthArrayAc.hpp
• Svc/ComQueue/ComQueueDepthArrayAc.cpp