WireCell::Iterator< ValueType > Class Template Reference

#include <Iterator.h>

Inheritance diagram for WireCell::Iterator< ValueType >:

Public Types
typedef WireCell::IteratorBase< ValueType >	BaseIteratorType

Public Member Functions
	Iterator ()
	Iterator (const Iterator &other)
	Iterator (const BaseIteratorType &base_other)
	~Iterator ()
bool	operator== (const Iterator &rhs) const
bool	operator!= (const Iterator &rhs) const
Iterator &	operator++ ()
ValueType	operator* () const
Iterator &	operator= (const Iterator &rhs)

Private Attributes
BaseIteratorType *	base_itr

Detailed Description

template<typename ValueType>
class WireCell::Iterator< ValueType >

This iterator provides a facade over a WireCell::IteratorBase<ValueType>.

This facade can be passed by value without slicing the abstract base iterator.

Definition at line 16 of file Iterator.h.

Member Typedef Documentation

template<typename ValueType >

typedef WireCell::IteratorBase<ValueType> WireCell::Iterator< ValueType >::BaseIteratorType

Definition at line 18 of file Iterator.h.

Constructor & Destructor Documentation

template<typename ValueType >

WireCell::Iterator< ValueType >::Iterator ( )

inline

Definition at line 21 of file Iterator.h.

: base_itr(0) { }

template<typename ValueType >

WireCell::Iterator< ValueType >::Iterator ( const Iterator< ValueType > &  other )

inline

Definition at line 24 of file Iterator.h.

                                        : base_itr(0) {
            if (other.base_itr) {
                base_itr = other.base_itr->clone();
            }
        }

template<typename ValueType >

WireCell::Iterator< ValueType >::Iterator ( const BaseIteratorType &  base_other )

inline

Definition at line 29 of file Iterator.h.

                                                     : base_itr(0) {
            base_itr = base_other.clone();
        }

template<typename ValueType >

WireCell::Iterator< ValueType >::~Iterator ( )

inline

Definition at line 32 of file Iterator.h.

                    {
            if (base_itr) {
                delete base_itr;
            }
            base_itr = 0;
        }

Member Function Documentation

template<typename ValueType >

bool WireCell::Iterator< ValueType >::operator!= ( const Iterator< ValueType > &  rhs ) const

inline

Definition at line 44 of file Iterator.h.

                                                   {
            if (base_itr && rhs.base_itr) {
                return *base_itr != *rhs.base_itr;
            }
            return base_itr != rhs.base_itr;
        }

template<typename ValueType >

ValueType WireCell::Iterator< ValueType >::operator* ( ) const

inline

Definition at line 56 of file Iterator.h.

                                    {
            return *(*base_itr);
        }

template<typename ValueType >

Iterator& WireCell::Iterator< ValueType >::operator++ ( )

inline

Definition at line 51 of file Iterator.h.

                               {
            ++(*base_itr);
            return *this;
        }

template<typename ValueType >

Iterator& WireCell::Iterator< ValueType >::operator= ( const Iterator< ValueType > &  rhs )

inline

Definition at line 60 of file Iterator.h.

                                                 {
            if (base_itr) {
                delete base_itr;
            }
            base_itr = rhs.base_itr->clone();
            return *this;
        }

template<typename ValueType >

bool WireCell::Iterator< ValueType >::operator== ( const Iterator< ValueType > &  rhs ) const

inline

Definition at line 39 of file Iterator.h.

                                                   {
            if (base_itr == rhs.base_itr) return true;
            if (!base_itr || !rhs.base_itr) return false;
            return *base_itr == *rhs.base_itr;   
        }

Member Data Documentation

template<typename ValueType >

BaseIteratorType* WireCell::Iterator< ValueType >::base_itr

private

Definition at line 69 of file Iterator.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/Iterator.h