F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Svc::ComQueueDepth Class Reference

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

#include <Svc/ComQueue/ComQueueDepthArrayAc.hpp>

Inheritance diagram for Svc::ComQueueDepth:
Fw::Serializable

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 = NATIVE_UINT_TYPE
 

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...
 
ElementTypeoperator[] (const U32 i)
 Subscript operator. More...
 
const ElementTypeoperator[] (const U32 i) const
 Const subscript operator. More...
 
ComQueueDepthoperator= (const ComQueueDepth &obj)
 Copy assignment operator (object) More...
 
ComQueueDepthoperator= (const ElementType(&a)[SIZE])
 Copy assignment operator (raw array) More...
 
ComQueueDepthoperator= (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 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::Com types.

Definition at line 18 of file ComQueueDepthArrayAc.hpp.

Member Typedef Documentation

◆ ElementType

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 16 of file ComQueueDepthArrayAc.cpp.

◆ ComQueueDepth() [2/5]

Svc::ComQueueDepth::ComQueueDepth ( const ElementType(&)  a[SIZE])

Constructor (user-provided value)

Parameters
aThe array

Definition at line 27 of file ComQueueDepthArrayAc.cpp.

◆ ComQueueDepth() [3/5]

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

Constructor (single element)

Parameters
eThe element

Definition at line 36 of file ComQueueDepthArrayAc.cpp.

◆ ComQueueDepth() [4/5]

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

Constructor (multiple elements)

Parameters
e1Element 1
e2Element 2

Definition at line 45 of file ComQueueDepthArrayAc.cpp.

◆ ComQueueDepth() [5/5]

Svc::ComQueueDepth::ComQueueDepth ( const ComQueueDepth obj)

Copy Constructor.

Parameters
objThe source object

Definition at line 56 of file ComQueueDepthArrayAc.cpp.

Member Function Documentation

◆ deserialize()

Fw::SerializeStatus Svc::ComQueueDepth::deserialize ( Fw::SerializeBufferBase buffer)
virtual

Deserialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 159 of file ComQueueDepthArrayAc.cpp.

◆ operator!=()

bool Svc::ComQueueDepth::operator!= ( const ComQueueDepth obj) const

Inequality operator.

Parameters
objThe other object

Definition at line 125 of file ComQueueDepthArrayAc.cpp.

◆ operator=() [1/3]

ComQueueDepth & Svc::ComQueueDepth::operator= ( const ComQueueDepth obj)

Copy assignment operator (object)

Parameters
objThe source object

Definition at line 83 of file ComQueueDepthArrayAc.cpp.

◆ operator=() [2/3]

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

Copy assignment operator (single element)

Parameters
eThe element

Definition at line 105 of file ComQueueDepthArrayAc.cpp.

◆ operator=() [3/3]

ComQueueDepth & Svc::ComQueueDepth::operator= ( const ElementType(&)  a[SIZE])

Copy assignment operator (raw array)

Parameters
aThe source array

Definition at line 96 of file ComQueueDepthArrayAc.cpp.

◆ operator==()

bool Svc::ComQueueDepth::operator== ( const ComQueueDepth obj) const

Equality operator.

Parameters
objThe other object

Definition at line 114 of file ComQueueDepthArrayAc.cpp.

◆ operator[]() [1/2]

ComQueueDepth::ElementType & Svc::ComQueueDepth::operator[] ( const U32  i)

Subscript operator.

Parameters
iThe subscript index

Definition at line 69 of file ComQueueDepthArrayAc.cpp.

◆ operator[]() [2/2]

const ComQueueDepth::ElementType & Svc::ComQueueDepth::operator[] ( const U32  i) const

Const subscript operator.

Parameters
iThe subscript index

Definition at line 76 of file ComQueueDepthArrayAc.cpp.

◆ serialize()

Fw::SerializeStatus Svc::ComQueueDepth::serialize ( Fw::SerializeBufferBase buffer) const
virtual

Serialization.

Parameters
bufferThe serial buffer

Implements Fw::Serializable.

Definition at line 146 of file ComQueueDepthArrayAc.cpp.


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