Svc::BuffQueueDepth Class Reference

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

#include <Svc/ComQueue/BuffQueueDepthArrayAc.hpp>

Inheritance diagram for Svc::BuffQueueDepth:

Public Types
enum	{ SIZE = 1 , 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 = NATIVE_UINT_TYPE

Public Member Functions
	BuffQueueDepth ()
	Constructor (default value) More...
	BuffQueueDepth (const ElementType(&a)[SIZE])
	Constructor (user-provided value) More...
	BuffQueueDepth (const ElementType &e1)
	Constructor (multiple elements) More...
	BuffQueueDepth (const BuffQueueDepth &obj)
	Copy Constructor. More...
ElementType &	operator[] (const U32 i)
	Subscript operator. More...
const ElementType &	operator[] (const U32 i) const
	Const subscript operator. More...
BuffQueueDepth &	operator= (const BuffQueueDepth &obj)
	Copy assignment operator (object) More...
BuffQueueDepth &	operator= (const ElementType(&a)[SIZE])
	Copy assignment operator (raw array) More...
BuffQueueDepth &	operator= (const ElementType &e)
	Copy assignment operator (single element) More...
bool	operator== (const BuffQueueDepth &obj) const
	Equality operator. More...
bool	operator!= (const BuffQueueDepth &obj) const
	Inequality operator. More...
Fw::SerializeStatus	serialize (Fw::SerializeBufferBase &buffer) const
	Serialization. More...
Fw::SerializeStatus	deserialize (Fw::SerializeBufferBase &buffer)
	Deserialization. More...

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::Buffer types.

Definition at line 18 of file BuffQueueDepthArrayAc.hpp.

Member Typedef Documentation

ElementType

using Svc::BuffQueueDepth::ElementType = U32

The element type.

Definition at line 29 of file BuffQueueDepthArrayAc.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 BuffQueueDepthArrayAc.hpp.

Constructor & Destructor Documentation

BuffQueueDepth() [1/4]

Svc::BuffQueueDepth::BuffQueueDepth

(

)

Constructor (default value)

Definition at line 16 of file BuffQueueDepthArrayAc.cpp.

BuffQueueDepth() [2/4]

Svc::BuffQueueDepth::BuffQueueDepth

(

const ElementType(&)

a[SIZE]

)

Constructor (user-provided value)

Parameters

a

The array

Definition at line 26 of file BuffQueueDepthArrayAc.cpp.

BuffQueueDepth() [3/4]

Svc::BuffQueueDepth::BuffQueueDepth

(

const ElementType &

e1

)

Constructor (multiple elements)

Parameters

e1

Element 1

Definition at line 35 of file BuffQueueDepthArrayAc.cpp.

BuffQueueDepth() [4/4]

Svc::BuffQueueDepth::BuffQueueDepth

(

const BuffQueueDepth &

obj

)

Copy Constructor.

Parameters

obj	The source object

Definition at line 42 of file BuffQueueDepthArrayAc.cpp.

Member Function Documentation

deserialize()

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

virtual

Deserialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 145 of file BuffQueueDepthArrayAc.cpp.

operator!=()

bool Svc::BuffQueueDepth::operator!=

(

const BuffQueueDepth &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 111 of file BuffQueueDepthArrayAc.cpp.

operator=() [1/3]

BuffQueueDepth & Svc::BuffQueueDepth::operator=

(

const BuffQueueDepth &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 69 of file BuffQueueDepthArrayAc.cpp.

operator=() [2/3]

BuffQueueDepth & Svc::BuffQueueDepth::operator=

(

const ElementType &

e

)

Copy assignment operator (single element)

Parameters

e	The element

Definition at line 91 of file BuffQueueDepthArrayAc.cpp.

operator=() [3/3]

BuffQueueDepth & Svc::BuffQueueDepth::operator=

(

const ElementType(&)

a[SIZE]

)

Copy assignment operator (raw array)

Parameters

a	The source array

Definition at line 82 of file BuffQueueDepthArrayAc.cpp.

operator==()

bool Svc::BuffQueueDepth::operator==

(

const BuffQueueDepth &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 100 of file BuffQueueDepthArrayAc.cpp.

operator[]() [1/2]

BuffQueueDepth::ElementType & Svc::BuffQueueDepth::operator[]

(

const U32

i

)

Subscript operator.

Parameters

i	The subscript index

Definition at line 55 of file BuffQueueDepthArrayAc.cpp.

operator[]() [2/2]

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

(

const U32

i

)

const

Const subscript operator.

Parameters

i	The subscript index

Definition at line 62 of file BuffQueueDepthArrayAc.cpp.

serialize()

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

virtual

Serialization.

Parameters

buffer

The serial buffer

Implements Fw::Serializable.

Definition at line 132 of file BuffQueueDepthArrayAc.cpp.

---

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

• Svc/ComQueue/BuffQueueDepthArrayAc.hpp
• Svc/ComQueue/BuffQueueDepthArrayAc.cpp