lsst::afw::table::python::PyCatalogIndexIterator< Record > Class Template Reference

#include <catalog.h>

Public Types
using	value_type = std::shared_ptr<Record>
using	reference = std::shared_ptr<Record>
using	difference_type = std::ptrdiff_t
using	iterator_category = std::input_iterator_tag

Public Member Functions
	PyCatalogIndexIterator (CatalogT< Record > const *catalog, std::size_t index)
std::shared_ptr< Record >	operator* () const
PyCatalogIndexIterator &	operator++ ()
bool	operator== (PyCatalogIndexIterator const &other) const
bool	operator!= (PyCatalogIndexIterator const &other) const

Detailed Description

template<typename Record>
class lsst::afw::table::python::PyCatalogIndexIterator< Record >

Definition at line 122 of file catalog.h.

Member Typedef Documentation

difference_type

template<typename Record >

using lsst::afw::table::python::PyCatalogIndexIterator< Record >::difference_type = std::ptrdiff_t

Definition at line 127 of file catalog.h.

iterator_category

template<typename Record >

using lsst::afw::table::python::PyCatalogIndexIterator< Record >::iterator_category = std::input_iterator_tag

Definition at line 128 of file catalog.h.

reference

template<typename Record >

using lsst::afw::table::python::PyCatalogIndexIterator< Record >::reference = std::shared_ptr<Record>

Definition at line 126 of file catalog.h.

value_type

template<typename Record >

using lsst::afw::table::python::PyCatalogIndexIterator< Record >::value_type = std::shared_ptr<Record>

Definition at line 125 of file catalog.h.

Constructor & Destructor Documentation

PyCatalogIndexIterator()

template<typename Record >

lsst::afw::table::python::PyCatalogIndexIterator< Record >::PyCatalogIndexIterator ( CatalogT< Record > const * catalog, std::size_t index )

inline

Definition at line 130 of file catalog.h.

: _catalog(catalog), _index(index) {}

Member Function Documentation

operator!=()

template<typename Record >

bool lsst::afw::table::python::PyCatalogIndexIterator< Record >::operator!= ( PyCatalogIndexIterator< Record > const & other ) const

inline

Definition at line 150 of file catalog.h.

                                                                {
        return !(*this == other);
    }

operator*()

template<typename Record >

std::shared_ptr< Record > lsst::afw::table::python::PyCatalogIndexIterator< Record >::operator* ( ) const

inline

Definition at line 132 of file catalog.h.

                                            {
        if (_index < _catalog->size()) {
            return _catalog->get(_index);
        }
        throw std::out_of_range(
            "Catalog shrunk during iteration, invalidating this iterator."
        );
    }

operator++()

template<typename Record >

PyCatalogIndexIterator & lsst::afw::table::python::PyCatalogIndexIterator< Record >::operator++ ( )

inline

Definition at line 141 of file catalog.h.

                                          {
        ++_index;
        return *this;
    }

operator==()

template<typename Record >

bool lsst::afw::table::python::PyCatalogIndexIterator< Record >::operator== ( PyCatalogIndexIterator< Record > const & other ) const

inline

Definition at line 146 of file catalog.h.

                                                                {
        return _catalog == other._catalog && _index == other._index;
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/include/lsst/afw/table/python/catalog.h