axom::sidre::ListCollection< T > Class Template Reference

ListCollection is a container class template for holding a collection of items of template parameter type T, using a list container. More...

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

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

Public Types
using	value_type = T
using	iterator = typename ItemCollection< T >::iterator
using	const_iterator = typename ItemCollection< T >::const_iterator

Public Member Functions
size_t	getNumItems () const
IndexType	getFirstValidIndex () const
IndexType	getNextValidIndex (IndexType idx) const
bool	hasItem (IndexType idx) const
T *	getItem (IndexType idx)
T const *	getItem (IndexType idx) const
IndexType	insertItem (T *item, const std::string &name="")
T *	removeItem (IndexType idx)
void	removeAllItems ()
iterator	begin ()
iterator	end ()
const_iterator	cbegin () const
const_iterator	cend () const
const_iterator	begin () const
const_iterator	end () const
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::ListCollection< T >

ListCollection is a container class template for holding a collection of items of template parameter type T, using a list container.

Member Typedef Documentation

value_type

template<typename T >

using axom::sidre::ListCollection< T >::value_type = T

iterator

template<typename T >

using axom::sidre::ListCollection< T >::iterator = typename ItemCollection<T>::iterator

const_iterator

template<typename T >

using axom::sidre::ListCollection< T >::const_iterator = typename ItemCollection<T>::const_iterator

Member Function Documentation

getNumItems()

template<typename T >

size_t axom::sidre::ListCollection< T >::getNumItems ( ) const

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

getFirstValidIndex()

template<typename T >

IndexType axom::sidre::ListCollection< T >::getFirstValidIndex

virtual

Implements axom::sidre::ItemCollection< T >.

References axom::sidre::InvalidIndex.

getNextValidIndex()

template<typename T >

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

virtual

Implements axom::sidre::ItemCollection< T >.

References axom::sidre::InvalidIndex.

hasItem()

template<typename T >

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

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

getItem() [1/2]

template<typename T >

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

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

References axom::sidre::ListCollection< T >::hasItem().

getItem() [2/2]

template<typename T >

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

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

References axom::sidre::ListCollection< T >::hasItem().

insertItem()

template<typename T >

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

virtual

Implements axom::sidre::ItemCollection< T >.

References SLIC_WARNING_IF.

removeItem()

template<typename T >

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

virtual

Implements axom::sidre::ItemCollection< T >.

removeAllItems()

template<typename T >

void axom::sidre::ListCollection< T >::removeAllItems ( )

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

begin() [1/2]

template<typename T >

iterator axom::sidre::ListCollection< T >::begin ( )

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

end() [1/2]

template<typename T >

iterator axom::sidre::ListCollection< T >::end ( )

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

cbegin()

template<typename T >

const_iterator axom::sidre::ListCollection< T >::cbegin ( ) const

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

cend()

template<typename T >

const_iterator axom::sidre::ListCollection< T >::cend ( ) const

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

begin() [2/2]

template<typename T >

const_iterator axom::sidre::ListCollection< T >::begin ( ) const

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

end() [2/2]

template<typename T >

const_iterator axom::sidre::ListCollection< T >::end ( ) const

inlinevirtual

Implements axom::sidre::ItemCollection< T >.

getIteratorAdaptor() [1/2]

template<typename T >

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

inlineinherited

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

inlineinherited

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/sidre/core/ListCollection.hpp