SG::detail::IteratorBase Class Reference

Implementation class, not to be used directly Iterates over valid proxies in the range. More...

#include <SGIterator.h>

Inheritance diagram for SG::detail::IteratorBase:

Collaboration diagram for SG::detail::IteratorBase:

Public Member Functions
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
	IteratorBase ()=default
	Default constructor.
	IteratorBase (SG::ConstProxyIterator itr, SG::ConstProxyIterator itrEnd, bool isConst)
	Constructor from proxy iterator pair.
template<DataProxyIterator ITERATOR>
	IteratorBase (ITERATOR itr, ITERATOR itrEnd, bool isConst)
	Constructor from iterator pair over DataProxy*.
	IteratorBase (const IteratorBase &other)
	Copy constructor.
	~IteratorBase ()
	Destructor.
IteratorBase &	operator= (const IteratorBase &other)
	Assignment.
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
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
class	::SGImplSvc

Detailed Description

Implementation class, not to be used directly Iterates over valid proxies in the range.

Maintains a reference count on proxies within the range.

Definition at line 42 of file SGIterator.h.

Constructor & Destructor Documentation

IteratorBase() [1/4]

SG::detail::IteratorBase::IteratorBase ( )

protecteddefault

Default constructor.

IteratorBase() [2/4]

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

explicitprotected

Constructor from proxy iterator pair.

Parameters

itr	Starting proxy iterator.
itrEnd	Ending proxy iterator.
isConst	If false, take only non-const proxies.

Will skip ahead to the first valid proxy.

Definition at line 23 of file SGIterator.cxx.

{
  setState (itr, itrEnd, isConst).ignore();
}

IteratorBase() [3/4]

template<DataProxyIterator ITERATOR>

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

explicitprotected

Constructor from iterator pair over DataProxy*.

Parameters

itr	Starting iterator.
itrEnd	Ending iterator.
isConst	If false, take only non-const proxies.

Will skip ahead to the first valid proxy.

IteratorBase() [4/4]

SG::detail::IteratorBase::IteratorBase ( const IteratorBase & other )

protected

Copy constructor.

Definition at line 34 of file SGIterator.cxx.

  : m_proxies (other.m_proxies)
{
  // Maintain shared ownership of elements in our range.
  this->addRef();
}

~IteratorBase()

SG::detail::IteratorBase::~IteratorBase ( )

protected

Destructor.

Definition at line 45 of file SGIterator.cxx.

{
  // Release ownership of everything in our range.
  this->release();
}

Member Function Documentation

addRef()

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

private

Add a reference count to all proxies in our range.

const_check()

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

protected

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)");
  }
}

eql()

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

protected

Equality check.

increment()

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

protected

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

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

Definition at line 142 of file SGIterator.cxx.

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

operator=()

SG::detail::IteratorBase & SG::detail::IteratorBase::operator= ( const IteratorBase & other )

protected

Assignment.

Definition at line 56 of file SGIterator.cxx.

{
  if (this != &other) {
    // Assign, maintaining refcounts.
    this->release();
    m_proxies = other.m_proxies;
    this->addRef();
  }
  return *this;
}

proxy()

DataProxy * SG::detail::IteratorBase::proxy

(

)

const

The proxy pointed at by this iterator.

release()

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

private

Remove a reference count from all proxies in our range.

setState() [1/2]

template<DataProxyIterator ITERATOR>

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

protected

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/2]

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

protected

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;
}

Friends And Related Symbol Documentation

::SGImplSvc

friend class ::SGImplSvc

friend

Definition at line 48 of file SGIterator.h.

boost::iterator_core_access

friend class boost::iterator_core_access

friend

Definition at line 45 of file SGIterator.h.

Member Data Documentation

m_proxies

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

private

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 files:

• SGIterator.h
• SGIterator.cxx