ATLAS Offline Software
Public Member Functions | List of all members
HLT::ComboIteratorBase Class Referenceabstract

Base class for iterator used to loop over multi-particle combinations. More...

#include <ComboIterator.h>

Inheritance diagram for HLT::ComboIteratorBase:
Collaboration diagram for HLT::ComboIteratorBase:

Public Member Functions

 ComboIteratorBase ()
 Constructor. More...
 
virtual ~ComboIteratorBase ()
 Destructor. More...
 
virtual bool rewind ()=0
 Rewind method, resetting the iterator to the first element. More...
 
virtual TEVecoperator* ()=0
 Unary * operator, used to recover the current combination. More...
 
virtual bool isValid () const =0
 Validity check for the iterator. More...
 
virtual TEVeccombination ()=0
 Accessor method for the current combination. More...
 
virtual ComboIteratorBaseoperator++ (int)=0
 Post increment operator. More...
 
virtual ComboIteratorBaseoperator++ ()=0
 Pre increment operator. More...
 

Detailed Description

Base class for iterator used to loop over multi-particle combinations.

Author
Carlo Schiavi Carlo.nosp@m..Sch.nosp@m.iavi@.nosp@m.ge.i.nosp@m.nfn.i.nosp@m.t - INFN Genova

The iterator classes inheriting this interface are used by HLT algorithms to iterate over multi-particle combinations.

Definition at line 28 of file ComboIterator.h.

Constructor & Destructor Documentation

◆ ComboIteratorBase()

HLT::ComboIteratorBase::ComboIteratorBase ( )
inline

Constructor.

Definition at line 33 of file ComboIterator.h.

33 {}

◆ ~ComboIteratorBase()

virtual HLT::ComboIteratorBase::~ComboIteratorBase ( )
inlinevirtual

Destructor.

Definition at line 36 of file ComboIterator.h.

36 {}

Member Function Documentation

◆ combination()

virtual TEVec& HLT::ComboIteratorBase::combination ( )
pure virtual

Accessor method for the current combination.

Implemented in HLT::ComboIterator.

◆ isValid()

virtual bool HLT::ComboIteratorBase::isValid ( ) const
pure virtual

Validity check for the iterator.

Returns
result of the validity check; returns false if iterator is at end, true otherwise.

Implemented in HLT::ComboIterator.

◆ operator*()

virtual TEVec& HLT::ComboIteratorBase::operator* ( )
pure virtual

Unary * operator, used to recover the current combination.

Implemented in HLT::ComboIterator.

◆ operator++() [1/2]

virtual ComboIteratorBase& HLT::ComboIteratorBase::operator++ ( )
pure virtual

Pre increment operator.

Implemented in HLT::ComboIterator.

◆ operator++() [2/2]

virtual ComboIteratorBase& HLT::ComboIteratorBase::operator++ ( int  )
pure virtual

Post increment operator.

Implemented in HLT::ComboIterator.

◆ rewind()

virtual bool HLT::ComboIteratorBase::rewind ( )
pure virtual

Rewind method, resetting the iterator to the first element.

Implemented in HLT::ComboIterator.


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