SG::Iterator< DATA > Class Template Reference

an iterator facade to DATA. More...

#include <SGIterator.h>

Inheritance diagram for SG::Iterator< DATA >:

Collaboration diagram for SG::Iterator< DATA >:

Public Member Functions
	Iterator ()
	Default constructor.
	Iterator (SG::ConstProxyIterator itr, SG::ConstProxyIterator itrEnd)
	Constructor from proxy iterator pair.
StatusCode	setState (SG::ConstProxyIterator itr, SG::ConstProxyIterator itrEnd)
	Reset state of the iterator.
DataProxy *	proxy () const
	The proxy pointed at by this iterator.
const std::string &	key () const
	Get the key string with which the current object was stored.

Protected Member Functions
StatusCode	setState (SG::ConstProxyIterator itr, SG::ConstProxyIterator itrEnd, bool isConst)
	Reset state of the iterator.
template<DataProxyIterator ITERATOR>
StatusCode	setState (ITERATOR itr, ITERATOR itrEnd, bool isConst)
	Reset state of the iterator.
void	increment ()
	Move to the next valid proxy.
bool	eql (const IteratorBase &rhs) const
	Equality check.
void	const_check () const
	Const check: throw an exception if we're pointing at a const proxy.

Private Member Functions
bool	equal (const Iterator< DATA > &rhs) const
	Equality check.
DATA &	dereference () const
	Dereference the iterator.
void	addRef ()
	Add a reference count to all proxies in our range.
void	release ()
	Remove a reference count from all proxies in our range.

Private Attributes
std::vector< SG::DataProxy * >	m_proxies
	All proxies in our range, in reverse order.

Friends
class	boost::iterator_core_access

Detailed Description

template<class DATA>
class SG::Iterator< DATA >

an iterator facade to DATA.

Behaves like a forward iterator

Definition at line 345 of file SGIterator.h.

Constructor & Destructor Documentation

Iterator() [1/2]

template<class DATA>

SG::Iterator< DATA >::Iterator

(

)

Default constructor.

Iterator() [2/2]

template<class DATA>

SG::Iterator< DATA >::Iterator ( SG::ConstProxyIterator< DATA > itr, SG::ConstProxyIterator< DATA > itrEnd )

explicit

Constructor from proxy iterator pair.

Parameters

itr	Starting proxy iterator.
itrEnd	Ending proxy iterator.

Will skip ahead to the first valid proxy.

Member Function Documentation

addRef()

void SG::detail::IteratorBase::addRef ( )

privateinherited

Add a reference count to all proxies in our range.

const_check()

void SG::detail::IteratorBase::const_check ( ) const

protectedinherited

Const check: throw an exception if we're pointing at a const proxy.

Called when dereferencing a non-const iterator.

Definition at line 124 of file SGIterator.cxx.

{
  // This should usually not be needed, since we check for constness
  // when initializing the iterator.  However, it is possible for a proxy
  // to be marked as const after the iterator has been formed, so keep the check.
  const SG::DataProxy* dp = this->proxy();
  if (dp->isConst()) {
    const IProxyDict* store = dp->store();
    throw SG::ExcConstObject (dp->clID(),
                              dp->name(),
                              store ? store->name() : "(unknown)");
  }
}

dereference()

template<class DATA>

DATA & SG::Iterator< DATA >::dereference ( ) const

private

Dereference the iterator.

Used by the boost iterator adapter.

Will throw SG::ExcInvalidIterator() if the proxy is not valid. Will throw SG::ExcConstObject if the proxy is const.

eql()

bool SG::detail::IteratorBase::eql ( const IteratorBase & rhs ) const

protectedinherited

Equality check.

equal()

template<class DATA>

bool SG::Iterator< DATA >::equal ( const Iterator< DATA > & rhs ) const

private

Equality check.

Used by the boost iterator adapter.

increment()

void SG::detail::IteratorBase::increment ( )

protectedinherited

Move to the next valid proxy.

Used by the boost iterator adapter.

Definition at line 110 of file SGIterator.cxx.

{
  if (!m_proxies.empty()) {
    m_proxies.back()->release();
    m_proxies.pop_back();
  }
}

key()

const std::string & SG::detail::IteratorBase::key ( ) const

inherited

Get the key string with which the current object was stored.

Definition at line 142 of file SGIterator.cxx.

{
  return m_proxies.back()->name();
}

proxy()

DataProxy * SG::detail::IteratorBase::proxy ( ) const

inherited

The proxy pointed at by this iterator.

release()

void SG::detail::IteratorBase::release ( )

privateinherited

Remove a reference count from all proxies in our range.

setState() [1/3]

template<DataProxyIterator ITERATOR>

StatusCode SG::detail::IteratorBase::setState ( ITERATOR itr, ITERATOR itrEnd, bool isConst )

protectedinherited

Reset state of the iterator.

Parameters

itr	Starting iterator over DataProxy*.
itrEnd	Ending iterator.
isConst	Is this for a const iterator?

Will skip ahead to the first valid proxy. Returns FAILURE if the range is empty.

setState() [2/3]

StatusCode SG::detail::IteratorBase::setState ( SG::ConstProxyIterator itr, SG::ConstProxyIterator itrEnd, bool isConst )

protectedinherited

Reset state of the iterator.

Parameters

itr	Starting proxy iterator.
itrEnd	Ending proxy iterator.
isConst	Is this for a const iterator?

Will skip ahead to the first valid proxy. Returns FAILURE if the range is empty.

Definition at line 78 of file SGIterator.cxx.

{
  if (!m_proxies.empty()) {
    this->release();
    m_proxies.clear();
  }
 
  // Save all valid proxies in reverse order.  Also take out a refcount on each.
  while (itr != itrEnd) {
    --itrEnd;
    DataProxy* dp = itrEnd->second;
    if (dp->isValid() && (isConst || !dp->isConst())) {
      m_proxies.push_back (dp);
      dp->addRef();
    }
  }
 
  if (m_proxies.empty()) {
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

setState() [3/3]

template<class DATA>

StatusCode SG::Iterator< DATA >::setState	(	SG::ConstProxyIterator< DATA >	itr,
		SG::ConstProxyIterator< DATA >	itrEnd )

Reset state of the iterator.

Parameters

itr	Starting proxy iterator.
itrEnd	Ending proxy iterator.

Will skip ahead to the first valid proxy. Will return failure if the first proxy is const or if the range is empty.

Friends And Related Symbol Documentation

boost::iterator_core_access

template<class DATA>

friend class boost::iterator_core_access

friend

Definition at line 384 of file SGIterator.h.

Member Data Documentation

m_proxies

std::vector<SG::DataProxy*> SG::detail::IteratorBase::m_proxies

privateinherited

All proxies in our range, in reverse order.

Definition at line 176 of file SGIterator.h.

---

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

• SGIterator.h