axom::ItemCollection< T > Class Template Reference

ItemCollection is an abstract base class template for holding a collection of items of template parameter type T. Derived child classes can determine how to specifically store the items. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ItemCollection.hpp>

Inheritance diagram for axom::ItemCollection< T >:

Classes
class	const_iterator
	An std-compliant forward iterator for a const ItemCollection. More...
class	const_iterator_adaptor
	Utility class to wrap a const ItemCollection in support of iteration. More...
class	iterator
	An std-compliant forward iterator for an ItemCollection. More...
class	iterator_adaptor
	Utility class to wrap an ItemCollection in support of iteration. More...

Public Types
using	value_type = T

Public Member Functions
virtual	~ItemCollection ()
virtual size_t	getNumItems () const =0
virtual IndexType	getFirstValidIndex () const =0
virtual IndexType	getNextValidIndex (IndexType idx) const =0
virtual bool	hasItem (IndexType idx) const =0
virtual T *	getItem (IndexType idx)=0
virtual T const *	getItem (IndexType idx) const =0
virtual IndexType	insertItem (T *item, const std::string &name="")=0
virtual T *	removeItem (IndexType idx)=0
virtual void	removeAllItems ()=0
virtual iterator	begin ()=0
virtual iterator	end ()=0
virtual const_iterator	cbegin () const =0
virtual const_iterator	cend () const =0
virtual const_iterator	begin () const =0
virtual const_iterator	end () const =0
iterator_adaptor	getIteratorAdaptor ()
	Returns an adaptor wrapping this collection in support of iteration. More...
const_iterator_adaptor	getIteratorAdaptor () const
	Returns a const adaptor wrapping this collection in support of iteration. More...

Detailed Description

template<typename T>
class axom::ItemCollection< T >

ItemCollection is an abstract base class template for holding a collection of items of template parameter type T. Derived child classes can determine how to specifically store the items.

Member Typedef Documentation

value_type

template<typename T >

using axom::ItemCollection< T >::value_type = T

Constructor & Destructor Documentation

~ItemCollection()

template<typename T >

virtual axom::ItemCollection< T >::~ItemCollection ( )

inlinevirtual

Member Function Documentation

getNumItems()

template<typename T >

virtual size_t axom::ItemCollection< T >::getNumItems ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

getFirstValidIndex()

template<typename T >

virtual IndexType axom::ItemCollection< T >::getFirstValidIndex ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

getNextValidIndex()

template<typename T >

virtual IndexType axom::ItemCollection< T >::getNextValidIndex ( IndexType  idx ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

hasItem()

template<typename T >

virtual bool axom::ItemCollection< T >::hasItem ( IndexType  idx ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

getItem() [1/2]

template<typename T >

virtual T* axom::ItemCollection< T >::getItem ( IndexType  idx )

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

getItem() [2/2]

template<typename T >

virtual T const* axom::ItemCollection< T >::getItem ( IndexType  idx ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

insertItem()

template<typename T >

virtual IndexType axom::ItemCollection< T >::insertItem ( T *  item, const std::string &  name = ""  )

pure virtual

Implemented in axom::ListCollection< T >, and axom::MapCollection< T >.

removeItem()

template<typename T >

virtual T* axom::ItemCollection< T >::removeItem ( IndexType  idx )

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

removeAllItems()

template<typename T >

virtual void axom::ItemCollection< T >::removeAllItems ( )

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

begin() [1/2]

template<typename T >

virtual iterator axom::ItemCollection< T >::begin ( )

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

end() [1/2]

template<typename T >

virtual iterator axom::ItemCollection< T >::end ( )

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

cbegin()

template<typename T >

virtual const_iterator axom::ItemCollection< T >::cbegin ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

cend()

template<typename T >

virtual const_iterator axom::ItemCollection< T >::cend ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

begin() [2/2]

template<typename T >

virtual const_iterator axom::ItemCollection< T >::begin ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

end() [2/2]

template<typename T >

virtual const_iterator axom::ItemCollection< T >::end ( ) const

pure virtual

Implemented in axom::MapCollection< T >, axom::ListCollection< T >, and axom::IndexedCollection< T >.

getIteratorAdaptor() [1/2]

template<typename T >

iterator_adaptor axom::ItemCollection< T >::getIteratorAdaptor ( )

inline

Returns an adaptor wrapping this collection in support of iteration.

getIteratorAdaptor() [2/2]

template<typename T >

const_iterator_adaptor axom::ItemCollection< T >::getIteratorAdaptor ( ) const

inline

Returns a const adaptor wrapping this collection in support of iteration.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/core/ItemCollection.hpp