Teuchos - Trilinos Tools Package Version of the Day
Teuchos::StringIndexedOrderedValueObjectContainer< ObjType > Class Template Reference

String indexed ordered value-type object container class. More...

#include <Teuchos_StringIndexedOrderedValueObjectContainer.hpp>

Inheritance diagram for Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >:
Teuchos::StringIndexedOrderedValueObjectContainerBase

List of all members.

Public Types

Public types.
typedef
StringIndexedOrderedValueObjectContainerBase::Ordinal 
Ordinal
 Ordinal used for the index.
typedef FilteredIterator
< typename
key_and_obj_array_t::iterator,
SelectActive< ObjType > > 
Iterator
 The non-const iterator type.
typedef FilteredIterator
< typename
key_and_obj_array_t::const_iterator,
SelectActive< ObjType > > 
ConstIterator
 The const iterator type.

Public Member Functions

Constructors/Destructors/Info
 StringIndexedOrderedValueObjectContainer ()
 
Ordinal numObjects () const
 
Ordinal numStorage () const
 
Set, get, and remove functions
Ordinal setObj (const std::string &key, const ObjType &obj)
 Set (or reset) object by value and return its ordinal index.
Ordinal getObjOrdinalIndex (const std::string &key) const
 Get the ordinal index given the string key.
Ptr< ObjType > getNonconstObjPtr (const Ordinal &idx)
 Get a nonconst semi-persisting association with the stored object indexed by ordinal.
Ptr< const ObjType > getObjPtr (const Ordinal &idx) const
 Get a const semi-persisting association with the stored object indexed by ordinal.
Ptr< ObjType > getNonconstObjPtr (const std::string &key)
 Get a nonconst semi-persisting association with the stored object indexed by string key.
Ptr< const ObjType > getObjPtr (const std::string &key) const
 Get a const semi-persisting association with the stored object indexed by string key.
void removeObj (const Ordinal &idx)
 Remove an object given its ordinal index.
void removeObj (const std::string &key)
 Remove an object given its string key.
Iterator access
Iterator nonconstBegin ()
 
Iterator nonconstEnd ()
 
ConstIterator begin () const
 
ConstIterator end () const
 

Detailed Description

template<class ObjType>
class Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >

String indexed ordered value-type object container class.

This class is a simple utility class for managing the storage and retrievel of value-type objects which the following features/properties:

The design of this class comes with a few important limitations:

Todo:
Implement compression of unused entries. This will invalidate the indexes but will allow handling of lots of inserts and deletes of elements.

Definition at line 175 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.


Member Typedef Documentation

Ordinal used for the index.

Reimplemented from Teuchos::StringIndexedOrderedValueObjectContainerBase.

Definition at line 193 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>
typedef FilteredIterator<typename key_and_obj_array_t::iterator, SelectActive<ObjType> > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::Iterator

The non-const iterator type.

Definition at line 197 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType>
typedef FilteredIterator<typename key_and_obj_array_t::const_iterator, SelectActive<ObjType> > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator

The const iterator type.

Definition at line 201 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.


Constructor & Destructor Documentation


Member Function Documentation

template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::numObjects ( ) const
template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::numStorage ( ) const
template<class ObjType>
StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::setObj ( const std::string &  key,
const ObjType &  obj 
)

Set (or reset) object by value and return its ordinal index.

If the object with the given key index does not exist, it will be added. If an object with the given key does not exist, it will be created.

Returns:
Returns the ordinal index by which the object can be looked up with.

Definition at line 471 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::Ordinal Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjOrdinalIndex ( const std::string &  key) const [inline]

Get the ordinal index given the string key.

If the key does not exist, then getInvalidOrdinal() is returned.

Definition at line 459 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
Ptr< ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getNonconstObjPtr ( const Ordinal idx) [inline]

Get a nonconst semi-persisting association with the stored object indexed by ordinal.

Definition at line 348 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
Ptr< const ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjPtr ( const Ordinal idx) const [inline]

Get a const semi-persisting association with the stored object indexed by ordinal.

Definition at line 357 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
Ptr< ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getNonconstObjPtr ( const std::string &  key) [inline]

Get a nonconst semi-persisting association with the stored object indexed by string key.

Definition at line 366 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
Ptr< const ObjType > Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::getObjPtr ( const std::string &  key) const [inline]

Get a const semi-persisting association with the stored object indexed by string key.

Definition at line 375 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::removeObj ( const Ordinal idx)

Remove an object given its ordinal index.

Each object is errased by assigning to a default-constructed ObjType(). This, for example, will wipe out the reference count for a smart pointer class or will unsize an array, etc..

Definition at line 490 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
void Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::removeObj ( const std::string &  key)

Remove an object given its string key.

Definition at line 499 of file Teuchos_StringIndexedOrderedValueObjectContainer.hpp.

template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::Iterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::nonconstBegin ( ) [inline]
template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::Iterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::nonconstEnd ( ) [inline]
template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::begin ( ) const [inline]
template<class ObjType >
StringIndexedOrderedValueObjectContainer< ObjType >::ConstIterator Teuchos::StringIndexedOrderedValueObjectContainer< ObjType >::end ( ) const [inline]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines