Trax3 3.1.0
trax track library
Loading...
Searching...
No Matches
trax::SignalCollectionDecorator Class Reference

A decorator for SignalCollection. More...

#include <C:/Trend/Development/Trax3/Code/trax/collections/SignalCollection.h>

Inheritance diagram for trax::SignalCollectionDecorator:

Public Types

typedef SignalCollection ComponentType
 Type of the decoree.
Public Types inherited from trax::CollectionDecorator< Decorator< SignalCollection > >
typedef Decorator< SignalCollection >::InterfaceType InterfaceType
typedef Decorator< SignalCollection >::collection_type collection_type
typedef Decorator< SignalCollection >::value_type value_type
Public Types inherited from trax::Decorator< SignalCollection >
typedef SignalCollection InterfaceType
 Type of the interface the decorator is decorating.
Public Types inherited from trax::Collection< SignalCollection, Signal >
using iterator
using const_iterator
using collection_type
using value_type

Public Member Functions

 SignalCollectionDecorator (std::unique_ptr< SignalCollection > pSignalCollection)
 Constructs the decorator.
Public Member Functions inherited from trax::CollectionDecorator< Decorator< SignalCollection > >
 CollectionDecorator (std::shared_ptr< InterfaceType > pComponent)
 Decorator constructor.
const char * TypeName () const noexcept override
IDType Add (std::shared_ptr< value_type > pItem) override
IDType AddRelaxed (std::shared_ptr< value_type > pItem) override
bool Remove (value_type *pItem, bool zeroIDs=false) override
int Take (collection_type &ct) override
void Clear () override
int Count () const override
collection_type::iterator begin () override
collection_type::const_iterator cbegin () const override
collection_type::iterator end () override
collection_type::const_iterator cend () const override
std::shared_ptr< value_type > GetFirst () const override
std::shared_ptr< value_type > GetNext (const std::shared_ptr< value_type > &pItem) const override
std::shared_ptr< value_type > GetLast () const override
std::shared_ptr< value_type > GetPrevious (const std::shared_ptr< value_type > &pItem) const override
std::shared_ptr< value_type > Get (IDType id) const override
void PushActive (IDType id) override
void PopActive () override
std::shared_ptr< value_type > GetActive () const override
bool IsMember (const value_type &item) const override
void ShiftIDs (int offset) override
IDType MaxID () const override
IDType MinID () const override
Public Member Functions inherited from trax::Decorator< SignalCollection >
Decorator & operator= (const Decorator &)=delete
InterfaceTypeComponent () const noexcept
 Decorator member function forwarding.
Public Member Functions inherited from trax::Collection< SignalCollection, Signal >
virtual bool IsValid () const noexcept=0
 Checks whether the elements in this collection are valid.
virtual IDType Add (std::shared_ptr< Signal > pValue_Type)=0
 Adds an element to the container and returns its index in the container.
virtual IDType AddRelaxed (std::shared_ptr< Signal > pTraxType)=0
 Adds an element to the container and returns its index in the container. Does not throw.
virtual bool Remove (Signal *pValue_Type, bool zeroIDs=false)=0
 Removes an element from this container.
virtual int Take (SignalCollection &collection_Type)=0
 Moves all the items from another container to this container.
virtual std::shared_ptr< SignalGetNext (const std::shared_ptr< Signal > &pValue_Type) const=0
virtual std::shared_ptr< SignalGetPrevious (const std::shared_ptr< Signal > &pValue_Type) const=0
 Collection (const Collection &)=delete
Collection & operator= (const Collection &)=delete
virtual bool IsMember (const value_type &item) const=0

Additional Inherited Members

Static Public Member Functions inherited from trax::SignalCollection
static dclspc std::unique_ptr< SignalCollectionMake () noexcept
 Makes a SignalCollection object.
Protected Member Functions inherited from trax::Decorator< SignalCollection >
void SetDecorator (InterfaceType *pDecorator) noexcept override
Protected Attributes inherited from trax::Decorator< SignalCollection >
std::shared_ptr< InterfaceTypem_pComponent
 Pointer to decorated object.
Protected Attributes inherited from trax::Collection< SignalCollection, Signal >
friend Decorator< Collection_Type >

Detailed Description

A decorator for SignalCollection.

With trax decorators can get used to augment trax objects with additional behaviour and services. Derive your own class from the decorator and overwrite its methods. Create your decorator with the trax object and supply it to the library instead of the original object.

Constructor & Destructor Documentation

◆ SignalCollectionDecorator()

trax::SignalCollectionDecorator::SignalCollectionDecorator ( std::unique_ptr< SignalCollection > pSignalCollection)
inline

Constructs the decorator.

Parameters
pSignalCollectionPointer to object to decorate.

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