#include <BaseStorage.hh>

Public Member Functions
	BaseStore ()

virtual	~BaseStore ()

virtual bool	Add (TPtr _object)
	Add given element. If the element has already been added or its name or ID conflict with other existing elements, then no work will be done.

virtual bool	AddDerived (UPtr _object)

virtual UIter	Begin ()
	Return an iterator to the beginning.

virtual bool	Contains (ConstTPtr _object) const
	Determine if store contains the given element.

virtual bool	ContainsId (unsigned int _id) const
	Determine if store contains the element with the given ID.

virtual bool	ContainsName (const std::string &_name) const
	Determine if store contains the element with the given name.

virtual UPtr	DerivedById (unsigned int _id) const

virtual UPtr	DerivedByIndex (unsigned int _index) const

virtual UPtr	DerivedByName (const std::string &_name) const

virtual void	Destroy (TPtr _object)
	Remove and destroy given element. If the given element does not exists, in this store, then no work will be done.

virtual void	DestroyAll ()
	Remove and destroy all elements in store.

virtual void	DestroyById (unsigned int _id)
	Remove and destroy element with the given ID. If the specified element does not exists in this store, then no work will be done.

virtual void	DestroyByIndex (unsigned int _index)
	Remove and destroy element at the given index. If the specified element does not exists in this store, then no work will be done.

virtual void	DestroyByName (const std::string &_name)
	Remove and destroy element with the given name. If the specified element does not exists in this store, then no work will be done.

virtual UIter	End ()
	Return an iterator to the end.

virtual TPtr	GetById (unsigned int _id) const
	Get element with the given ID.

virtual TPtr	GetByIndex (unsigned int _index) const
	Get element at the given index.

virtual TPtr	GetByName (const std::string &_name) const
	Get element with the given name.

virtual TPtr	Remove (TPtr _object)
	Remove given element. If the given element does not exists in this store, then no work will be done.

virtual void	RemoveAll ()
	Remove all elements from store.

virtual TPtr	RemoveById (unsigned int _id)
	Remove element with the given ID. If the specified element does not exists in this store, then no work will be done.

virtual TPtr	RemoveByIndex (unsigned int _index)
	Remove element at the given index. If the specified element does not exists in this store, then no work will be done.

virtual TPtr	RemoveByName (const std::string &_name)
	Remove element with the given name. If the specified element does not exists in this store, then no work will be done.

virtual UPtr	RemoveDerived (UPtr _object)

virtual UPtr	RemoveDerivedById (unsigned int _id)

virtual UPtr	RemoveDerivedByIndex (unsigned int _index)

virtual UPtr	RemoveDerivedByName (const std::string &_name)

virtual unsigned int	Size () const
	Get number of elements in this store.

Public Member Functions inherited from Store< T >
virtual	~Store ()=default
	Destructor.

Protected Member Functions
virtual bool	AddImpl (UPtr _object)

virtual ConstUIter	ConstIter (ConstTPtr _object) const
	Get a const iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual ConstUIter	ConstIterById (unsigned int _id) const
	Get a const iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual ConstUIter	ConstIterByIndex (unsigned int _index) const
	Get a const iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual ConstUIter	ConstIterByName (const std::string &_name) const
	Get a const iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual void	DestroyImpl (UIter _iter)

virtual bool	IsValidIter (ConstUIter _iter) const

virtual UIter	Iter (ConstTPtr _object)
	Get an iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual UIter	IterById (unsigned int _id)
	Get an iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual UIter	IterByIndex (unsigned int _index)
	Get an iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual UIter	IterByName (const std::string &_name)
	Get an iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store.

virtual UIter	RemoveConstness (ConstUIter _iter)

virtual UPtr	RemoveImpl (UIter _iter)

Protected Attributes
UStore	store

UStoreMap	storeMap

Constructor & Destructor Documentation

◆ BaseStore()

template<class T , class U >

BaseStore ( )

◆ ~BaseStore()

template<class T , class U >

~BaseStore ( )

virtual

Member Function Documentation

◆ Add()

template<class T , class U >

bool Add ( TPtr _object )

virtual

Add given element. If the element has already been added or its name or ID conflict with other existing elements, then no work will be done.

Parameters

[in] _object Element to be added

Returns: True if successful

Implements Store< T >.

References std::dynamic_pointer_cast(), std::endl(), and gzerr.

◆ AddDerived()

template<class T , class U >

bool AddDerived ( UPtr _object )

virtual

References std::endl(), and gzerr.

◆ AddImpl()

template<class T , class U >

bool AddImpl ( UPtr _object )

protectedvirtual

References std::endl(), gzerr, and string::size().

◆ Begin()

template<class T , class U >

BaseStore< T, U >::UIter Begin ( )

virtual

Return an iterator to the beginning.

Returns: Iterator to beginning

◆ ConstIter()

template<class T , class U >

BaseStore< T, U >::ConstUIter ConstIter ( ConstTPtr _object ) const

protectedvirtual

Get a const iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _object Object pointer

Returns: Const iterator to the object

◆ ConstIterById()

template<class T , class U >

BaseStore< T, U >::ConstUIter ConstIterById ( unsigned int _id ) const

protectedvirtual

Get a const iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _id Object id

Returns: Const iterator to the object

◆ ConstIterByIndex()

template<class T , class U >

BaseStore< T, U >::ConstUIter ConstIterByIndex ( unsigned int _index ) const

protectedvirtual

Get a const iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _index Object index

Returns: Const iterator to the object

References std::advance(), std::endl(), and gzerr.

◆ ConstIterByName()

template<class T , class U >

BaseStore< T, U >::ConstUIter ConstIterByName ( const std::string & _name ) const

protectedvirtual

Get a const iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _name Object name

Returns: Const iterator to the object

◆ Contains()

template<class T , class U >

bool Contains ( ConstTPtr _object ) const

virtual

Determine if store contains the given element.

Parameters

[in] _object The element in question

Returns: True if this store contains the given element

Implements Store< T >.

◆ ContainsId()

template<class T , class U >

bool ContainsId ( unsigned int _id ) const

virtual

Determine if store contains the element with the given ID.

Parameters

[in] _id ID of the element in question

Returns: True if this store contains the specified element

Implements Store< T >.

◆ ContainsName()

template<class T , class U >

bool ContainsName ( const std::string & _name ) const

virtual

Determine if store contains the element with the given name.

Parameters

[in] _name Name of the element in question

Returns: True if this store contains the specified element

Implements Store< T >.

◆ DerivedById()

template<class T , class U >

BaseStore< T, U >::UPtr DerivedById ( unsigned int _id ) const

virtual

◆ DerivedByIndex()

template<class T , class U >

BaseStore< T, U >::UPtr DerivedByIndex ( unsigned int _index ) const

virtual

◆ DerivedByName()

template<class T , class U >

BaseStore< T, U >::UPtr DerivedByName ( const std::string & _name ) const

virtual

◆ Destroy()

template<class T , class U >

void Destroy ( TPtr _object )

virtual

Remove and destroy given element. If the given element does not exists, in this store, then no work will be done.

Parameters

[in] _object Element to be removed

Implements Store< T >.

◆ DestroyAll()

template<class T , class U >

void DestroyAll ( )

virtual

Remove and destroy all elements in store.

Implements Store< T >.

◆ DestroyById()

template<class T , class U >

void DestroyById ( unsigned int _id )

virtual

Remove and destroy element with the given ID. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _id ID of the element to be removed

Implements Store< T >.

◆ DestroyByIndex()

template<class T , class U >

void DestroyByIndex ( unsigned int _index )

virtual

Remove and destroy element at the given index. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _index Index of the element to be removed

Implements Store< T >.

◆ DestroyByName()

template<class T , class U >

void DestroyByName ( const std::string & _name )

virtual

Remove and destroy element with the given name. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _name Name of the element to be removed

Implements Store< T >.

◆ DestroyImpl()

template<class T , class U >

void DestroyImpl ( UIter _iter )

protectedvirtual

◆ End()

template<class T , class U >

BaseStore< T, U >::UIter End ( )

virtual

Return an iterator to the end.

Returns: Iterator to end

◆ GetById()

template<class T , class U >

BaseStore< T, U >::TPtr GetById ( unsigned int _id ) const

virtual

Get element with the given ID.

Parameters

[in] _id ID of the desired element

Returns: The specified element

Implements Store< T >.

◆ GetByIndex()

template<class T , class U >

BaseStore< T, U >::TPtr GetByIndex ( unsigned int _index ) const

virtual

Get element at the given index.

Parameters

[in] _index Index of the desired element

Returns: The specified element

Implements Store< T >.

◆ GetByName()

template<class T , class U >

BaseStore< T, U >::TPtr GetByName ( const std::string & _name ) const

virtual

Get element with the given name.

Parameters

[in] _name Name of the desired element

Returns: The specified element

Implements Store< T >.

◆ IsValidIter()

template<class T , class U >

bool IsValidIter ( ConstUIter _iter ) const

protectedvirtual

◆ Iter()

template<class T , class U >

BaseStore< T, U >::UIter Iter ( ConstTPtr _object )

protectedvirtual

Get an iterator to the object by pointer. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _object Object pointer

Returns: Iterator to the object

◆ IterById()

template<class T , class U >

BaseStore< T, U >::UIter IterById ( unsigned int _id )

protectedvirtual

Get an iterator to the object by id. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _id Object id

Returns: Iterator to the object

◆ IterByIndex()

template<class T , class U >

BaseStore< T, U >::UIter IterByIndex ( unsigned int _index )

protectedvirtual

Get an iterator to the object by index. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _index Object index

Returns: Iterator to the object

◆ IterByName()

template<class T , class U >

BaseStore< T, U >::UIter IterByName ( const std::string & _name )

protectedvirtual

Get an iterator to the object by name. Note that the iterator may change or become invalid when objects are added to / removed from the store.

Parameters

[in] _name Object name

Returns: Iterator to the object

◆ Remove()

template<class T , class U >

BaseStore< T, U >::TPtr Remove ( TPtr _object )

virtual

Remove given element. If the given element does not exists in this store, then no work will be done.

Parameters

[in] _object Element to be removed

Returns: The removed element

Implements Store< T >.

◆ RemoveAll()

template<class T , class U >

void RemoveAll ( )

virtual

Remove all elements from store.

Implements Store< T >.

◆ RemoveById()

template<class T , class U >

BaseStore< T, U >::TPtr RemoveById ( unsigned int _id )

virtual

Remove element with the given ID. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _id ID of the element to be removed

Returns: The removed element

Implements Store< T >.

◆ RemoveByIndex()

template<class T , class U >

BaseStore< T, U >::TPtr RemoveByIndex ( unsigned int _index )

virtual

Remove element at the given index. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _index Index of the element to be removed

Returns: The removed element

Implements Store< T >.

◆ RemoveByName()

template<class T , class U >

BaseStore< T, U >::TPtr RemoveByName ( const std::string & _name )

virtual

Remove element with the given name. If the specified element does not exists in this store, then no work will be done.

Parameters

[in] _name Name of the element to be removed

Returns: The removed element

Implements Store< T >.

◆ RemoveConstness()

template<class T , class U >

BaseStore< T, U >::UIter RemoveConstness ( ConstUIter _iter )

protectedvirtual

◆ RemoveDerived()

template<class T , class U >

BaseStore< T, U >::UPtr RemoveDerived ( UPtr _object )

virtual

◆ RemoveDerivedById()

template<class T , class U >

BaseStore< T, U >::UPtr RemoveDerivedById ( unsigned int _id )

virtual

◆ RemoveDerivedByIndex()

template<class T , class U >

BaseStore< T, U >::UPtr RemoveDerivedByIndex ( unsigned int _index )

virtual

◆ RemoveDerivedByName()

template<class T , class U >

BaseStore< T, U >::UPtr RemoveDerivedByName ( const std::string & _name )

virtual

◆ RemoveImpl()

template<class T , class U >

BaseStore< T, U >::UPtr RemoveImpl ( UIter _iter )

protectedvirtual

References std::distance(), and string::erase().

◆ Size()

template<class T , class U >

unsigned int Size ( ) const

virtual

Get number of elements in this store.

Returns: The number of elements in this store

Implements Store< T >.

Member Data Documentation

◆ store

template<class T , class U >

UStore store

protected

◆ storeMap

template<class T , class U >

UStoreMap storeMap

protected

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

BaseStorage.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BaseStore()

◆ ~BaseStore()

Member Function Documentation

◆ Add()

◆ AddDerived()

◆ AddImpl()

◆ Begin()

◆ ConstIter()

◆ ConstIterById()

◆ ConstIterByIndex()

◆ ConstIterByName()

◆ Contains()

◆ ContainsId()

◆ ContainsName()

◆ DerivedById()

◆ DerivedByIndex()

◆ DerivedByName()

◆ Destroy()

◆ DestroyAll()

◆ DestroyById()

◆ DestroyByIndex()

◆ DestroyByName()

◆ DestroyImpl()

◆ End()

◆ GetById()

◆ GetByIndex()

◆ GetByName()

◆ IsValidIter()

◆ Iter()

◆ IterById()

◆ IterByIndex()

◆ IterByName()

◆ Remove()

◆ RemoveAll()

◆ RemoveById()

◆ RemoveByIndex()

◆ RemoveByName()

◆ RemoveConstness()

◆ RemoveDerived()

◆ RemoveDerivedById()

◆ RemoveDerivedByIndex()

◆ RemoveDerivedByName()

◆ RemoveImpl()

◆ Size()

Member Data Documentation

◆ store

◆ storeMap