Class SpatialCellCandidateIterator

Class Documentation

class SpatialCellCandidateIterator

An iterator that only returns usable members of the SpatialCell

Public 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)

Exceptions

  • lsst::pex::exceptions::NotFoundError: if no candidate is available

std::shared_ptr<SpatialCellCandidate> operator*()

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 Functions

SpatialCellCandidateIterator(CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad)

ctor; designed to be used to pass begin to SpatialCellCandidateIterator

Parameters

  • iterator: Where this iterator should start

  • end: One-past-the-end of iterator’s range

  • ignoreBad: Should we pass over bad Candidates?

SpatialCellCandidateIterator(CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad, bool)

ctor; designed to be used to pass end to SpatialCellCandidateIterator

Parameters

  • iterator: start of of iterator’s range; not used

  • end: Where this iterator should start

  • ignoreBad: Should we pass over bad Candidates?