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 (primitive array) More...
	ComQueueDepth (const ElementType &e)
	Constructor (single element) More...
	ComQueueDepth (const std::initializer_list< ElementType > &il)
	Constructor (initializer list) More...
	ComQueueDepth (const ComQueueDepth &obj)
	Copy constructor. More...
ElementType &	operator[] (const FwSizeType i)
	Subscript operator. More...
const ElementType &	operator[] (const FwSizeType 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 (primitive array) More...
ComQueueDepth &	operator= (const std::initializer_list< ElementType > &il)
	Copy assignment operator (initializer list) 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::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG) const
	Serialization. More...
Fw::SerializeStatus	deserializeFrom (Fw::SerialBufferBase &buffer, Fw::Endianness mode=Fw::Endianness::BIG)
	Deserialization. More...
FwSizeType	serializedSize () const
	Get the dynamic serialized size of the array. More...
Public Member Functions inherited from Fw::Serializable
Serializable &	operator= (const Serializable &src)=default
	TODO: this operator should be deleted, this must be done after RawTime is modified though. More...
	DEPRECATED (SerializeStatus serialize(SerialBufferBase &buffer) const, "Use serializeTo(SerialBufferBase& buffer) instead")
	DEPRECATED (SerializeStatus deserialize(SerialBufferBase &buffer), "Use deserializeFrom(SerialBufferBase& buffer) instead")

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

Detailed Description

Array of queue depths for Fw::Com types.

Definition at line 20 of file ComQueueDepthArrayAc.hpp.

Member Typedef Documentation

ElementType

using Svc::ComQueueDepth::ElementType = U32

The element type.

Definition at line 31 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 39 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 (primitive array)

Parameters

a

The array

Definition at line 24 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [3/5]

Svc::ComQueueDepth::ComQueueDepth ( const ElementType &  e )

explicit

Constructor (single element)

Parameters

e	The element

Definition at line 31 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [4/5]

Svc::ComQueueDepth::ComQueueDepth

(

const std::initializer_list< ElementType > &

il

)

Constructor (initializer list)

Parameters

il	The initializer list

Definition at line 38 of file ComQueueDepthArrayAc.cpp.

ComQueueDepth() [5/5]

Svc::ComQueueDepth::ComQueueDepth

(

const ComQueueDepth &

obj

)

Copy constructor.

Parameters

obj	The source object

Definition at line 45 of file ComQueueDepthArrayAc.cpp.

Member Function Documentation

deserializeFrom()

Fw::SerializeStatus Svc::ComQueueDepth::deserializeFrom ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  )

virtual

Deserialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 161 of file ComQueueDepthArrayAc.cpp.

operator!=()

bool Svc::ComQueueDepth::operator!=

(

const ComQueueDepth &

obj

)

const

Inequality operator.

Parameters

obj	The other object

Definition at line 124 of file ComQueueDepthArrayAc.cpp.

operator=() [1/4]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ComQueueDepth &

obj

)

Copy assignment operator (object)

Parameters

obj	The source object

Definition at line 70 of file ComQueueDepthArrayAc.cpp.

operator=() [2/4]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ElementType(&)

a[SIZE]

)

Copy assignment operator (primitive array)

Parameters

a	The source array

Definition at line 81 of file ComQueueDepthArrayAc.cpp.

operator=() [3/4]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const std::initializer_list< ElementType > &

il

)

Copy assignment operator (initializer list)

Parameters

il	The initializer list

Definition at line 90 of file ComQueueDepthArrayAc.cpp.

operator=() [4/4]

ComQueueDepth & Svc::ComQueueDepth::operator=

(

const ElementType &

e

)

Copy assignment operator (single element)

Parameters

e	The element

Definition at line 104 of file ComQueueDepthArrayAc.cpp.

operator==()

bool Svc::ComQueueDepth::operator==

(

const ComQueueDepth &

obj

)

const

Equality operator.

Parameters

obj	The other object

Definition at line 113 of file ComQueueDepthArrayAc.cpp.

operator[]() [1/2]

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

(

const FwSizeType

i

)

Subscript operator.

Parameters

i	The subscript index

Definition at line 56 of file ComQueueDepthArrayAc.cpp.

operator[]() [2/2]

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

(

const FwSizeType

i

)

const

Const subscript operator.

Parameters

i	The subscript index

Definition at line 63 of file ComQueueDepthArrayAc.cpp.

serializedSize()

FwSizeType Svc::ComQueueDepth::serializedSize

(

)

const

Get the dynamic serialized size of the array.

Definition at line 177 of file ComQueueDepthArrayAc.cpp.

serializeTo()

Fw::SerializeStatus Svc::ComQueueDepth::serializeTo ( Fw::SerialBufferBase &  buffer, Fw::Endianness  mode = Fw::Endianness::BIG  ) const

virtual

Serialization.

Parameters

buffer	The serial buffer
mode	Endianness of serialized buffer

Implements Fw::Serializable.

Definition at line 145 of file ComQueueDepthArrayAc.cpp.

---

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

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