lsst.afw gb3a676b8dc+b4feba26a1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
lsst::afw::math::SpatialCellCandidateIterator Class Reference

An iterator that only returns usable members of the SpatialCell. More...

#include <SpatialCell.h>

Public Member Functions

void operator++ ()
 Advance the iterator, maybe skipping over candidates labelled BAD.
 
size_t operator- (SpatialCellCandidateIterator const &rhs) const
 Return the number of candidate between this and rhs.
 
std::shared_ptr< SpatialCellCandidate const > operator* () const
 Dereference the iterator to return the Candidate (if there is one)
 
std::shared_ptr< SpatialCellCandidateoperator* ()
 Return the std::shared_ptr<CellCandidate>
 
bool operator== (SpatialCellCandidateIterator const &rhs) const
 Are two SpatialCellCandidateIterators equal?
 
bool operator!= (SpatialCellCandidateIterator const &rhs) const
 Are two SpatialCellCandidateIterators unequal?
 

Protected Member Functions

 SpatialCellCandidateIterator (CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad)
 ctor; designed to be used to pass begin to SpatialCellCandidateIterator
 
 SpatialCellCandidateIterator (CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad, bool)
 ctor; designed to be used to pass end to SpatialCellCandidateIterator
 

Friends

class SpatialCell
 

Detailed Description

An iterator that only returns usable members of the SpatialCell.

Definition at line 159 of file SpatialCell.h.

Constructor & Destructor Documentation

◆ SpatialCellCandidateIterator() [1/2]

lsst::afw::math::SpatialCellCandidateIterator::SpatialCellCandidateIterator ( CandidateList::iterator iterator,
CandidateList::iterator end,
bool ignoreBad )
protected

ctor; designed to be used to pass begin to SpatialCellCandidateIterator

Parameters
iteratorWhere this iterator should start
endOne-past-the-end of iterator's range
ignoreBadShould we pass over bad Candidates?

Definition at line 239 of file SpatialCell.cc.

◆ SpatialCellCandidateIterator() [2/2]

lsst::afw::math::SpatialCellCandidateIterator::SpatialCellCandidateIterator ( CandidateList::iterator iterator,
CandidateList::iterator end,
bool ignoreBad,
bool  )
protected

ctor; designed to be used to pass end to SpatialCellCandidateIterator

Parameters
iteratorstart of of iterator's range; not used
endWhere this iterator should start
ignoreBadShould we pass over bad Candidates?

Definition at line 251 of file SpatialCell.cc.

Member Function Documentation

◆ operator!=()

bool lsst::afw::math::SpatialCellCandidateIterator::operator!= ( SpatialCellCandidateIterator const & rhs) const
inline

Are two SpatialCellCandidateIterators unequal?

Definition at line 186 of file SpatialCell.h.

◆ operator*() [1/2]

std::shared_ptr< SpatialCellCandidate > lsst::afw::math::SpatialCellCandidateIterator::operator* ( )

Return the std::shared_ptr<CellCandidate>

Definition at line 293 of file SpatialCell.cc.

◆ operator*() [2/2]

std::shared_ptr< SpatialCellCandidate const > lsst::afw::math::SpatialCellCandidateIterator::operator* ( ) const

Dereference the iterator to return the Candidate (if there is one)

Exceptions
lsst::pex::exceptions::NotFoundErrorif no candidate is available

Definition at line 285 of file SpatialCell.cc.

◆ operator++()

void lsst::afw::math::SpatialCellCandidateIterator::operator++ ( )

Advance the iterator, maybe skipping over candidates labelled BAD.

Definition at line 260 of file SpatialCell.cc.

◆ operator-()

size_t lsst::afw::math::SpatialCellCandidateIterator::operator- ( SpatialCellCandidateIterator const & rhs) const

Return the number of candidate between this and rhs.

Definition at line 274 of file SpatialCell.cc.

◆ operator==()

bool lsst::afw::math::SpatialCellCandidateIterator::operator== ( SpatialCellCandidateIterator const & rhs) const
inline

Are two SpatialCellCandidateIterators equal?

Definition at line 184 of file SpatialCell.h.

Friends And Related Symbol Documentation

◆ SpatialCell

friend class SpatialCell
friend

Definition at line 160 of file SpatialCell.h.


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