F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Public Member Functions | Protected Member Functions | List of all members
Fw::SizedContainer Class Referenceabstract

#include <Fw/DataStructures/SizedContainer.hpp>

Inheritance diagram for Fw::SizedContainer:
Fw::FifoQueueBase< T > Fw::MapBase< K, V > Fw::SetBase< T > Fw::StackBase< T > Fw::MapBase< ComCfg::Apid::T, U16 > Fw::MapBase< FwChanIdType, FwSizeType > Fw::MapBase< FwOpcodeType, FwIndexType > Fw::MapBase< FwPrmIdType, Fw::ParamBuffer > Fw::MapBase< intptr_t, size_t > Fw::MapBase< U16, FwIndexType > Fw::MapBase< U32, FwIndexType > Fw::MapBase< U32, SequenceTrackerEntry > Fw::SetBase< DpStateEntry > Fw::SetBase< FwEventIdType > Fw::StackBase< Index >

Public Member Functions

virtual void clear ()=0
 Clear the container. More...
 
virtual FwSizeType getSize () const =0
 
virtual FwSizeType getCapacity () const =0
 
bool isEmpty () const
 
bool isFull () const
 

Protected Member Functions

 SizedContainer ()
 Zero-argument constructor. More...
 
virtual ~SizedContainer ()=default
 Destructor. More...
 

Detailed Description

Definition at line 14 of file SizedContainer.hpp.

Constructor & Destructor Documentation

◆ SizedContainer()

Fw::SizedContainer::SizedContainer ( )
inlineprotected

Zero-argument constructor.

Definition at line 30 of file SizedContainer.hpp.

◆ ~SizedContainer()

virtual Fw::SizedContainer::~SizedContainer ( )
protectedvirtualdefault

Destructor.

Member Function Documentation

◆ clear()

virtual void Fw::SizedContainer::clear ( )
pure virtual

Clear the container.

Implemented in Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalRedBlackTreeSet< DpStateEntry >, Fw::ExternalRedBlackTreeMap< K, V >, Fw::ExternalRedBlackTreeMap< intptr_t, size_t >, Fw::ExternalRedBlackTreeMap< FwChanIdType, FwSizeType >, Fw::ExternalRedBlackTreeMap< FwOpcodeType, FwIndexType >, Fw::ExternalArraySet< T >, Fw::ExternalArraySet< FwEventIdType >, Fw::ExternalArrayMap< K, V >, Fw::ExternalArrayMap< FwPrmIdType, Fw::ParamBuffer >, Fw::ExternalArrayMap< U16, FwIndexType >, Fw::ExternalArrayMap< U32, FwIndexType >, Fw::ExternalArrayMap< U32, SequenceTrackerEntry >, Fw::ExternalArrayMap< ComCfg::Apid::T, U16 >, Fw::RedBlackTreeMap< K, V, C >, Fw::RedBlackTreeMap< intptr_t, size_t, C >, Fw::RedBlackTreeMap< FwOpcodeType, FwIndexType, CMD_DISPATCHER_DISPATCH_TABLE_SIZE >, Fw::RedBlackTreeMap< FwChanIdType, FwSizeType, MAX_PACKETIZER_CHANNELS >, Fw::RedBlackTreeSet< T, C >, Fw::RedBlackTreeSet< DpStateEntry, DP_MAX_FILES >, Fw::ArrayMap< K, V, C >, Fw::ArraySet< T, C >, Fw::ExternalFifoQueue< T >, Fw::ArrayMap< U32, FwIndexType, SdlsCfg::SaRouterMaxOutstandingBuffers >, Fw::ArrayMap< ComCfg::Apid::T, U16, MAX_TRACKED_APIDS >, Fw::ArrayMap< U32, SequenceTrackerEntry, CMD_DISPATCHER_SEQUENCER_TABLE_SIZE >, Fw::ArrayMap< FwPrmIdType, Fw::ParamBuffer, PRMDB_NUM_DB_ENTRIES >, Fw::ArrayMap< U16, FwIndexType, SdlsCfg::SaRouterMapEntryCount >, Fw::ArraySet< FwEventIdType, TELEM_ID_FILTER_SIZE >, Fw::ExternalStack< T >, Fw::ExternalStack< Index >, Fw::FifoQueue< T, C >, and Fw::Stack< T, C >.

◆ getCapacity()

virtual FwSizeType Fw::SizedContainer::getCapacity ( ) const
pure virtual

Get the capacity (maximum number of items storable in the container)

Returns
The capacity

Implemented in Fw::ExternalFifoQueue< T >, Fw::ExternalStack< T >, Fw::ExternalStack< Index >, Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalRedBlackTreeSet< DpStateEntry >, Fw::ExternalRedBlackTreeMap< K, V >, Fw::ExternalRedBlackTreeMap< intptr_t, size_t >, Fw::ExternalRedBlackTreeMap< FwChanIdType, FwSizeType >, Fw::ExternalRedBlackTreeMap< FwOpcodeType, FwIndexType >, Fw::ExternalArraySet< T >, Fw::ExternalArraySet< FwEventIdType >, Fw::ExternalArrayMap< K, V >, Fw::ExternalArrayMap< FwPrmIdType, Fw::ParamBuffer >, Fw::ExternalArrayMap< U16, FwIndexType >, Fw::ExternalArrayMap< U32, FwIndexType >, Fw::ExternalArrayMap< U32, SequenceTrackerEntry >, Fw::ExternalArrayMap< ComCfg::Apid::T, U16 >, Fw::RedBlackTreeMap< K, V, C >, Fw::RedBlackTreeMap< intptr_t, size_t, C >, Fw::RedBlackTreeMap< FwOpcodeType, FwIndexType, CMD_DISPATCHER_DISPATCH_TABLE_SIZE >, Fw::RedBlackTreeMap< FwChanIdType, FwSizeType, MAX_PACKETIZER_CHANNELS >, Fw::RedBlackTreeSet< T, C >, Fw::RedBlackTreeSet< DpStateEntry, DP_MAX_FILES >, Fw::ArrayMap< K, V, C >, Fw::ArrayMap< U32, FwIndexType, SdlsCfg::SaRouterMaxOutstandingBuffers >, Fw::ArrayMap< ComCfg::Apid::T, U16, MAX_TRACKED_APIDS >, Fw::ArrayMap< U32, SequenceTrackerEntry, CMD_DISPATCHER_SEQUENCER_TABLE_SIZE >, Fw::ArrayMap< FwPrmIdType, Fw::ParamBuffer, PRMDB_NUM_DB_ENTRIES >, Fw::ArrayMap< U16, FwIndexType, SdlsCfg::SaRouterMapEntryCount >, Fw::ArraySet< T, C >, Fw::ArraySet< FwEventIdType, TELEM_ID_FILTER_SIZE >, Fw::FifoQueue< T, C >, and Fw::Stack< T, C >.

◆ getSize()

virtual FwSizeType Fw::SizedContainer::getSize ( ) const
pure virtual

Get the size (number of items stored in the container)

Returns
The size

Implemented in Fw::ExternalFifoQueue< T >, Fw::ExternalStack< T >, Fw::ExternalStack< Index >, Fw::ExternalRedBlackTreeSet< T >, Fw::ExternalRedBlackTreeSet< DpStateEntry >, Fw::ExternalRedBlackTreeMap< K, V >, Fw::ExternalRedBlackTreeMap< intptr_t, size_t >, Fw::ExternalRedBlackTreeMap< FwChanIdType, FwSizeType >, Fw::ExternalRedBlackTreeMap< FwOpcodeType, FwIndexType >, Fw::ExternalArraySet< T >, Fw::ExternalArraySet< FwEventIdType >, Fw::ExternalArrayMap< K, V >, Fw::ExternalArrayMap< FwPrmIdType, Fw::ParamBuffer >, Fw::ExternalArrayMap< U16, FwIndexType >, Fw::ExternalArrayMap< U32, FwIndexType >, Fw::ExternalArrayMap< U32, SequenceTrackerEntry >, Fw::ExternalArrayMap< ComCfg::Apid::T, U16 >, Fw::RedBlackTreeMap< K, V, C >, Fw::RedBlackTreeMap< intptr_t, size_t, C >, Fw::RedBlackTreeMap< FwOpcodeType, FwIndexType, CMD_DISPATCHER_DISPATCH_TABLE_SIZE >, Fw::RedBlackTreeMap< FwChanIdType, FwSizeType, MAX_PACKETIZER_CHANNELS >, Fw::RedBlackTreeSet< T, C >, Fw::RedBlackTreeSet< DpStateEntry, DP_MAX_FILES >, Fw::ArrayMap< K, V, C >, Fw::ArrayMap< U32, FwIndexType, SdlsCfg::SaRouterMaxOutstandingBuffers >, Fw::ArrayMap< ComCfg::Apid::T, U16, MAX_TRACKED_APIDS >, Fw::ArrayMap< U32, SequenceTrackerEntry, CMD_DISPATCHER_SEQUENCER_TABLE_SIZE >, Fw::ArrayMap< FwPrmIdType, Fw::ParamBuffer, PRMDB_NUM_DB_ENTRIES >, Fw::ArrayMap< U16, FwIndexType, SdlsCfg::SaRouterMapEntryCount >, Fw::ArraySet< T, C >, Fw::ArraySet< FwEventIdType, TELEM_ID_FILTER_SIZE >, Fw::FifoQueue< T, C >, and Fw::Stack< T, C >.

◆ isEmpty()

bool Fw::SizedContainer::isEmpty ( ) const
inline

Check whether the container is empty

Returns
True if the container is empty

Definition at line 63 of file SizedContainer.hpp.

◆ isFull()

bool Fw::SizedContainer::isFull ( ) const
inline

Check whether the container is full

Returns
True if the container is full

Definition at line 67 of file SizedContainer.hpp.

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