lsst::afw::table::CatalogIterator< BaseT > Class Template Reference

Iterator class for CatalogT. More...

#include <Catalog.h>

Inheritance diagram for lsst::afw::table::CatalogIterator< BaseT >:

Public Member Functions
	CatalogIterator ()
template<typename OtherBaseT >
	CatalogIterator (CatalogIterator< OtherBaseT > const &other)
	CatalogIterator (BaseT const &base)
template<typename RecordT >
	operator std::shared_ptr< RecordT > () const
template<typename RecordT >
CatalogIterator &	operator= (std::shared_ptr< RecordT > const &other) const

Friends
class	boost::iterator_core_access

Detailed Description

template<typename BaseT>
class lsst::afw::table::CatalogIterator< BaseT >

Iterator class for CatalogT.

Iterators dereference to record references or const references, even though the CatalogT container is based on a vector of shared_ptr internally. This is usually very convenient (and is one of the reasons for having a custom container class in the first place).

Sometimes, however, we'd like to get a shared_ptr from an iterator (especially because records are noncopyable). With that in mind, CatalogIterator is implicitly convertible to the shared_ptr type it holds internally, and can also be assigned a shared_ptr to set the pointer in the underlying container. This conversion makes sense from the perspective that both iterators and smart pointers mimic the interface of pointers and provide the same interface to get at the underlying record.

Definition at line 39 of file Catalog.h.

Constructor & Destructor Documentation

CatalogIterator() [1/3]

template<typename BaseT >

lsst::afw::table::CatalogIterator< BaseT >::CatalogIterator ( )

inline

Definition at line 42 of file Catalog.h.

{}

CatalogIterator() [2/3]

template<typename BaseT >

template<typename OtherBaseT >

lsst::afw::table::CatalogIterator< BaseT >::CatalogIterator ( CatalogIterator< OtherBaseT > const & other )

inline

Definition at line 45 of file Catalog.h.

            : CatalogIterator::iterator_adaptor_(other.base()) {}

CatalogIterator() [3/3]

template<typename BaseT >

lsst::afw::table::CatalogIterator< BaseT >::CatalogIterator ( BaseT const & base )

inlineexplicit

Definition at line 48 of file Catalog.h.

: CatalogIterator::iterator_adaptor_(base) {}

Member Function Documentation

operator std::shared_ptr< RecordT >()

template<typename BaseT >

template<typename RecordT >

lsst::afw::table::CatalogIterator< BaseT >::operator std::shared_ptr< RecordT > ( ) const

inline

Definition at line 51 of file Catalog.h.

                                            {
        return *this->base();
    }

operator=()

template<typename BaseT >

template<typename RecordT >

CatalogIterator & lsst::afw::table::CatalogIterator< BaseT >::operator= ( std::shared_ptr< RecordT > const & other ) const

inline

Definition at line 56 of file Catalog.h.

                                                                          {
        *this->base() = other;
        return *this;
    }

Friends And Related Symbol Documentation

boost::iterator_core_access

template<typename BaseT >

friend class boost::iterator_core_access

friend

Definition at line 62 of file Catalog.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/table/Catalog.h