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/latest/src/axom/sidre/core/ItemCollection.hpp>

Inheritance diagram for axom::sidre::ItemCollection< T >:

[legend]

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::sidre::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::sidre::ItemCollection< T >::value_type = T

Constructor & Destructor Documentation

◆ ~ItemCollection()

template<typename T >

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

inlinevirtual

Member Function Documentation

◆ getNumItems()

template<typename T >

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

pure virtual

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

◆ getFirstValidIndex()

template<typename T >

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

pure virtual

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

◆ getNextValidIndex()

template<typename T >

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

pure virtual

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

◆ hasItem()

template<typename T >

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

pure virtual

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

◆ getItem() [1/2]

template<typename T >

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

pure virtual

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

◆ getItem() [2/2]

template<typename T >

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

pure virtual

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

◆ insertItem()

template<typename T >

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

pure virtual

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

◆ removeItem()

template<typename T >

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

pure virtual

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

◆ removeAllItems()

template<typename T >

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

pure virtual

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

◆ begin() [1/2]

template<typename T >

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

pure virtual

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

◆ end() [1/2]

template<typename T >

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

pure virtual

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

◆ cbegin()

template<typename T >

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

pure virtual

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

◆ cend()

template<typename T >

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

pure virtual

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

◆ begin() [2/2]

template<typename T >

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

pure virtual

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

◆ end() [2/2]

template<typename T >

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

pure virtual

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

◆ getIteratorAdaptor() [1/2]

template<typename T >

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

inline

Returns an adaptor wrapping this collection in support of iteration.

◆ getIteratorAdaptor() [2/2]

template<typename T >

const_iterator_adaptor axom::sidre::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 files:

/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/sidre/core/Group.hpp
/home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/sidre/core/ItemCollection.hpp

Classes

Public Types

Public Member Functions

Detailed Description

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

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ ~ItemCollection()

Member Function Documentation

◆ getNumItems()

◆ getFirstValidIndex()

◆ getNextValidIndex()

◆ hasItem()

◆ getItem() [1/2]

◆ getItem() [2/2]

◆ insertItem()

◆ removeItem()

◆ removeAllItems()

◆ begin() [1/2]

◆ end() [1/2]

◆ cbegin()

◆ cend()

◆ begin() [2/2]

◆ end() [2/2]

◆ getIteratorAdaptor() [1/2]

◆ getIteratorAdaptor() [2/2]

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