dchain::WholeCandidateItr< CandidateClass > Class Template Reference

#include <WholeCandidateItr.h>

Public Types
typedef const LabeledCandidate< CandidateClass >	value_type
typedef dchain::candidateitr::size_type	distance_type
typedef dchain::candidateitr::size_type	size_type
typedef dchain::candidateitr::difference_type	difference_type
typedef std::random_access_iterator_tag	iterator_category
typedef const LabeledCandidate< CandidateClass > *	pointer
typedef const LabeledCandidate< CandidateClass > &	reference

Public Member Functions
	WholeCandidateItr (const WholeCandidateItr< CandidateClass > &aOtherItr)
virtual	~WholeCandidateItr ()
const WholeCandidateItr &	operator= (const WholeCandidateItr< CandidateClass > &aOtherItr)
WholeCandidateItr< CandidateClass > &	operator++ ()
WholeCandidateItr< CandidateClass >	operator++ (int)
WholeCandidateItr< CandidateClass > &	operator-- ()
WholeCandidateItr< CandidateClass >	operator-- (int)
WholeCandidateItr< CandidateClass > &	operator+= (difference_type n)
WholeCandidateItr< CandidateClass >	operator+ (difference_type n)
WholeCandidateItr< CandidateClass > &	operator-= (difference_type n)
WholeCandidateItr< CandidateClass >	operator- (difference_type n)
const LabeledCandidate< CandidateClass > &	operator* () const
const LabeledCandidate< CandidateClass > &	operator[] (size_type n) const
difference_type	operator- (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator== (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator!= (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator< (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator> (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator>= (const WholeCandidateItr< CandidateClass > &aOtherItr) const
bool	operator<= (const WholeCandidateItr< CandidateClass > &aOtherItr) const

Protected Member Functions
	WholeCandidateItr (const IndexedLabeledCandidates< CandidateClass > *aList, const size_type aIndex)
IndexedLabeledCandidates< CandidateClass > *	indexedCandidates () const
size_type	index () const

Friends
class	LabeledCandidateList< CandidateClass >

Detailed Description

template<class CandidateClass>
class dchain::WholeCandidateItr< CandidateClass >

Definition at line 83 of file LabeledCandidateList.h.

Member Typedef Documentation

difference_type

template<class CandidateClass >

dchain::candidateitr::difference_type dchain::WholeCandidateItr< CandidateClass >::difference_type

Definition at line 55 of file WholeCandidateItr.h.

distance_type

template<class CandidateClass >

dchain::candidateitr::size_type dchain::WholeCandidateItr< CandidateClass >::distance_type

Definition at line 53 of file WholeCandidateItr.h.

iterator_category

template<class CandidateClass >

std::random_access_iterator_tag dchain::WholeCandidateItr< CandidateClass >::iterator_category

Definition at line 56 of file WholeCandidateItr.h.

pointer

template<class CandidateClass >

const LabeledCandidate<CandidateClass>* dchain::WholeCandidateItr< CandidateClass >::pointer

Definition at line 57 of file WholeCandidateItr.h.

reference

template<class CandidateClass >

const LabeledCandidate<CandidateClass>& dchain::WholeCandidateItr< CandidateClass >::reference

Definition at line 58 of file WholeCandidateItr.h.

size_type

template<class CandidateClass >

dchain::candidateitr::size_type dchain::WholeCandidateItr< CandidateClass >::size_type

Definition at line 54 of file WholeCandidateItr.h.

value_type

template<class CandidateClass >

const LabeledCandidate<CandidateClass> dchain::WholeCandidateItr< CandidateClass >::value_type

Definition at line 52 of file WholeCandidateItr.h.

Constructor & Destructor Documentation

WholeCandidateItr() [1/2]

template<class CandidateClass >

dchain::WholeCandidateItr< CandidateClass >::WholeCandidateItr ( const WholeCandidateItr< CandidateClass > & aOtherItr )

inline

Definition at line 146 of file WholeCandidateItr.h.

                                                                                                             :
   m_indexedCandidates( aOtherItr.indexedCandidates() ) ,
   m_index( aOtherItr.index() )
{
}

~WholeCandidateItr()

template<class CandidateClass >

virtual dchain::WholeCandidateItr< CandidateClass >::~WholeCandidateItr ( )

inlinevirtual

Definition at line 63 of file WholeCandidateItr.h.

{}

WholeCandidateItr() [2/2]

template<class CandidateClass >

dchain::WholeCandidateItr< CandidateClass >::WholeCandidateItr ( const IndexedLabeledCandidates< CandidateClass > * aList, const size_type aIndex )

inlineprotected

Definition at line 154 of file WholeCandidateItr.h.

                                                 :
// cast away const as const_itr can be assocciated with a non-const list,
//   but only const lists use this constructor
   m_indexedCandidates( (IndexedLabeledCandidates< CandidateClass >*)aList ) ,
   m_index( aIndex )
{   
}

Member Function Documentation

index()

template<class CandidateClass >

WholeCandidateItr< CandidateClass >::size_type dchain::WholeCandidateItr< CandidateClass >::index ( ) const

inlineprotected

Definition at line 135 of file WholeCandidateItr.h.

{
   return ( m_index ) ;
}

indexedCandidates()

template<class CandidateClass >

IndexedLabeledCandidates< CandidateClass > * dchain::WholeCandidateItr< CandidateClass >::indexedCandidates ( ) const

inlineprotected

Definition at line 128 of file WholeCandidateItr.h.

{
   return ( m_indexedCandidates ) ;
}

operator!=()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator!= ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 282 of file WholeCandidateItr.h.

{
   return ( ( m_index != aOtherItr.index() ) ||
        ( m_indexedCandidates != aOtherItr.indexedCandidates() ) ) ;
}

operator*()

template<class CandidateClass >

const LabeledCandidate< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator* ( ) const

inline

Definition at line 252 of file WholeCandidateItr.h.

{
   return ( (*m_indexedCandidates).labeledCandidateClass( m_index ) ) ;
}

operator+()

template<class CandidateClass >

WholeCandidateItr< CandidateClass > dchain::WholeCandidateItr< CandidateClass >::operator+ ( difference_type n )

inline

Definition at line 224 of file WholeCandidateItr.h.

{
   WholeCandidateItr tmp( *this ) ;
   return ( tmp += n ) ;
}

operator++() [1/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator++ ( )

inline

Definition at line 182 of file WholeCandidateItr.h.

{
   ++m_index ;
   return ( *this ) ;
}

Referenced by dchain::WholeItr< DecayClass >::operator++(), and dchain::WholeItr< DecayClass >::operator++().

operator++() [2/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass > dchain::WholeCandidateItr< CandidateClass >::operator++ ( int )

inline

Definition at line 190 of file WholeCandidateItr.h.

{
   WholeCandidateItr tmp( *this ) ;
   ++m_index ;
   return ( tmp ) ;
}

operator+=()

template<class CandidateClass >

WholeCandidateItr< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator+= ( difference_type n )

inline

Definition at line 216 of file WholeCandidateItr.h.

{
   m_index += n ;
   return( *this ) ;
}

operator-() [1/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass >::difference_type dchain::WholeCandidateItr< CandidateClass >::operator- ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 267 of file WholeCandidateItr.h.

{
   return ( m_index - aOtherItr.index() ) ;
}

operator-() [2/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass > dchain::WholeCandidateItr< CandidateClass >::operator- ( difference_type n )

inline

Definition at line 240 of file WholeCandidateItr.h.

{
   WholeCandidateItr tmp( *this ) ;
   return ( tmp -= n ) ;
}

operator--() [1/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator-- ( )

inline

Definition at line 199 of file WholeCandidateItr.h.

{
   --m_index ;
   return ( *this ) ;
}

Referenced by dchain::WholeItr< DecayClass >::operator--(), and dchain::WholeItr< DecayClass >::operator--().

operator--() [2/2]

template<class CandidateClass >

WholeCandidateItr< CandidateClass > dchain::WholeCandidateItr< CandidateClass >::operator-- ( int )

inline

Definition at line 207 of file WholeCandidateItr.h.

{
   WholeCandidateItr tmp( *this ) ;
   --m_index ;
   return ( tmp ) ;
}

operator-=()

template<class CandidateClass >

WholeCandidateItr< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator-= ( difference_type n )

inline

Definition at line 232 of file WholeCandidateItr.h.

{
   m_index -= n ;
   return( *this ) ;
}

Referenced by dchain::WholeItr< DecayClass >::operator-=().

operator<()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator< ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 290 of file WholeCandidateItr.h.

{
   return ( ( m_index < aOtherItr.index() ) &&
        ( m_indexedCandidates == aOtherItr.indexedCandidates() ) ) ;
}

operator<=()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator<= ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 314 of file WholeCandidateItr.h.

{
   return ( ( m_index <= aOtherItr.index() ) &&
        ( m_indexedCandidates == aOtherItr.indexedCandidates() ) ) ;
}

operator=()

template<class CandidateClass >

const WholeCandidateItr< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator= ( const WholeCandidateItr< CandidateClass > & aOtherItr )

inline

Definition at line 169 of file WholeCandidateItr.h.

{
   m_indexedCandidates = aOtherItr.indexedCandidates() ;
   m_index = aOtherItr.index() ;
   return ( *this ) ;
}

Referenced by dchain::WholeItr< DecayClass >::operator=().

operator==()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator== ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 274 of file WholeCandidateItr.h.

{
   return ( ( m_index == aOtherItr.index() ) &&
        ( m_indexedCandidates == aOtherItr.indexedCandidates() ) ) ;
}

operator>()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator> ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 298 of file WholeCandidateItr.h.

{
   return ( ( m_index > aOtherItr.index() ) &&
        ( m_indexedCandidates == aOtherItr.indexedCandidates() ) ) ;
}

operator>=()

template<class CandidateClass >

bool dchain::WholeCandidateItr< CandidateClass >::operator>= ( const WholeCandidateItr< CandidateClass > & aOtherItr ) const

inline

Definition at line 306 of file WholeCandidateItr.h.

{
   return ( ( m_index >= aOtherItr.index() ) &&
        ( m_indexedCandidates == aOtherItr.indexedCandidates() ) ) ;
}

operator[]()

template<class CandidateClass >

const LabeledCandidate< CandidateClass > & dchain::WholeCandidateItr< CandidateClass >::operator[] ( size_type n ) const

inline

Definition at line 259 of file WholeCandidateItr.h.

{
   return ( (*m_indexedCandidates).labeledCandidateClass( m_index + n ) ) ;
}

Friends And Related Symbol Documentation

LabeledCandidateList< CandidateClass >

template<class CandidateClass >

friend class LabeledCandidateList< CandidateClass >

friend

Definition at line 314 of file WholeCandidateItr.h.

---

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

• WholeCandidateItr.h
• CandidateList.h
• IndexedLabeledCandidates.h
• LabeledCandidateList.h