AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
Public Member Functions | List of all members
axom::sidre::ItemCollection< TYPE > Class Template Referenceabstract

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

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

Inheritance diagram for axom::sidre::ItemCollection< TYPE >:
Inheritance graph
[legend]

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 (const std::string &name) const =0
 
virtual bool hasItem (IndexType idx) const =0
 
virtual TYPE * getItem (const std::string &name)=0
 
virtual TYPE const * getItem (const std::string &name) const =0
 
virtual TYPE * getItem (IndexType idx)=0
 
virtual TYPE const * getItem (IndexType idx) const =0
 
virtual const std::string & getItemName (IndexType idx) const =0
 
virtual IndexType getItemIndex (const std::string &name) const =0
 
virtual IndexType insertItem (TYPE *item, const std::string &name)=0
 
virtual TYPE * removeItem (const std::string &name)=0
 
virtual TYPE * removeItem (IndexType idx)=0
 
virtual void removeAllItems ()=0
 

Detailed Description

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

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

Constructor & Destructor Documentation

◆ ~ItemCollection()

template<typename TYPE >
virtual axom::sidre::ItemCollection< TYPE >::~ItemCollection ( )
inlinevirtual

References axom::sidre::ItemCollection< TYPE >::getFirstValidIndex(), axom::sidre::ItemCollection< TYPE >::getItem(), axom::sidre::ItemCollection< TYPE >::getItemIndex(), axom::sidre::ItemCollection< TYPE >::getItemName(), axom::sidre::ItemCollection< TYPE >::getNextValidIndex(), axom::sidre::ItemCollection< TYPE >::getNumItems(), axom::sidre::ItemCollection< TYPE >::hasItem(), axom::sidre::ItemCollection< TYPE >::insertItem(), axom::sidre::ItemCollection< TYPE >::removeAllItems(), and axom::sidre::ItemCollection< TYPE >::removeItem().

Member Function Documentation

◆ getNumItems()

template<typename TYPE >
virtual size_t axom::sidre::ItemCollection< TYPE >::getNumItems ( ) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ getFirstValidIndex()

template<typename TYPE >
virtual IndexType axom::sidre::ItemCollection< TYPE >::getFirstValidIndex ( ) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ getNextValidIndex()

template<typename TYPE >
virtual IndexType axom::sidre::ItemCollection< TYPE >::getNextValidIndex ( IndexType  idx) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ hasItem() [1/2]

template<typename TYPE >
virtual bool axom::sidre::ItemCollection< TYPE >::hasItem ( const std::string &  name) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ hasItem() [2/2]

template<typename TYPE >
virtual bool axom::sidre::ItemCollection< TYPE >::hasItem ( IndexType  idx) const
pure virtual

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

◆ getItem() [1/4]

template<typename TYPE >
virtual TYPE* axom::sidre::ItemCollection< TYPE >::getItem ( const std::string &  name)
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ getItem() [2/4]

template<typename TYPE >
virtual TYPE const* axom::sidre::ItemCollection< TYPE >::getItem ( const std::string &  name) const
pure virtual

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

◆ getItem() [3/4]

template<typename TYPE >
virtual TYPE* axom::sidre::ItemCollection< TYPE >::getItem ( IndexType  idx)
pure virtual

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

◆ getItem() [4/4]

template<typename TYPE >
virtual TYPE const* axom::sidre::ItemCollection< TYPE >::getItem ( IndexType  idx) const
pure virtual

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

◆ getItemName()

template<typename TYPE >
virtual const std::string& axom::sidre::ItemCollection< TYPE >::getItemName ( IndexType  idx) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ getItemIndex()

template<typename TYPE >
virtual IndexType axom::sidre::ItemCollection< TYPE >::getItemIndex ( const std::string &  name) const
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ insertItem()

template<typename TYPE >
virtual IndexType axom::sidre::ItemCollection< TYPE >::insertItem ( TYPE *  item,
const std::string &  name 
)
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ removeItem() [1/2]

template<typename TYPE >
virtual TYPE* axom::sidre::ItemCollection< TYPE >::removeItem ( const std::string &  name)
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

◆ removeItem() [2/2]

template<typename TYPE >
virtual TYPE* axom::sidre::ItemCollection< TYPE >::removeItem ( IndexType  idx)
pure virtual

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

◆ removeAllItems()

template<typename TYPE >
virtual void axom::sidre::ItemCollection< TYPE >::removeAllItems ( )
pure virtual

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

Referenced by axom::sidre::ItemCollection< TYPE >::~ItemCollection().

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