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

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

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

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

Public Member Functions
size_t	getNumItems () const
IndexType	getFirstValidIndex () const
IndexType	getNextValidIndex (IndexType idx) const
bool	hasItem (const std::string &name) const
bool	hasItem (IndexType idx) const
TYPE *	getItem (const std::string &name)
TYPE const *	getItem (const std::string &name) const
TYPE *	getItem (IndexType idx)
TYPE const *	getItem (IndexType idx) const
const std::string &	getItemName (IndexType idx) const
IndexType	getItemIndex (const std::string &name) const
IndexType	insertItem (TYPE *item, const std::string &name)
TYPE *	removeItem (const std::string &name)
TYPE *	removeItem (IndexType idx)
void	removeAllItems ()

Detailed Description

template<typename TYPE>
class axom::sidre::ListCollection< TYPE >

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

Member Function Documentation

getNumItems()

template<typename TYPE >

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

inlinevirtual

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

References axom::sidre::ListCollection< TYPE >::getFirstValidIndex(), and axom::sidre::ListCollection< TYPE >::getNextValidIndex().

getFirstValidIndex()

template<typename TYPE >

IndexType axom::sidre::ListCollection< TYPE >::getFirstValidIndex ( ) const

virtual

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

References axom::sidre::InvalidIndex.

Referenced by axom::sidre::ListCollection< TYPE >::getNumItems().

getNextValidIndex()

template<typename TYPE >

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

virtual

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

References axom::sidre::InvalidIndex.

Referenced by axom::sidre::ListCollection< TYPE >::getNumItems().

hasItem() [1/2]

template<typename TYPE >

bool axom::sidre::ListCollection< TYPE >::hasItem ( const std::string &  name ) const

inlinevirtual

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

References SLIC_WARNING.

Referenced by axom::sidre::ListCollection< TYPE >::getItem(), and axom::sidre::ListCollection< TYPE >::removeItem().

hasItem() [2/2]

template<typename TYPE >

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

inlinevirtual

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

getItem() [1/4]

template<typename TYPE >

TYPE* axom::sidre::ListCollection< TYPE >::getItem ( const std::string &  name )

inlinevirtual

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

References SLIC_WARNING.

getItem() [2/4]

template<typename TYPE >

TYPE const* axom::sidre::ListCollection< TYPE >::getItem ( const std::string &  name ) const

inlinevirtual

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

References SLIC_WARNING.

getItem() [3/4]

template<typename TYPE >

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

inlinevirtual

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

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

getItem() [4/4]

template<typename TYPE >

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

inlinevirtual

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

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

getItemName()

template<typename TYPE >

const std::string& axom::sidre::ListCollection< TYPE >::getItemName ( IndexType  idx ) const

inlinevirtual

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

References axom::sidre::InvalidName, and SLIC_WARNING.

getItemIndex()

template<typename TYPE >

IndexType axom::sidre::ListCollection< TYPE >::getItemIndex ( const std::string &  name ) const

inlinevirtual

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

References axom::sidre::ListCollection< TYPE >::insertItem(), axom::sidre::ListCollection< TYPE >::removeItem(), and SLIC_WARNING.

insertItem()

template<typename TYPE >

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

virtual

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

References SLIC_WARNING_IF.

Referenced by axom::sidre::ListCollection< TYPE >::getItemIndex().

removeItem() [1/2]

template<typename TYPE >

TYPE * axom::sidre::ListCollection< TYPE >::removeItem ( const std::string &  name )

virtual

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

References SLIC_WARNING.

Referenced by axom::sidre::ListCollection< TYPE >::getItemIndex().

removeItem() [2/2]

template<typename TYPE >

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

virtual

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

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

removeAllItems()

template<typename TYPE >

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

inlinevirtual

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

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/sidre/core/ListCollection.hpp