OpenWalnut  1.5.0dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
WIteratorRange< IteratorType > Class Template Reference

A range of iterators. More...

#include <WIteratorRange.h>

+ Collaboration diagram for WIteratorRange< IteratorType >:

Public Member Functions

 WIteratorRange (IteratorType const &begin, IteratorType const &end)
 Construct a range from a begin and end iterator. More...
 
 ~WIteratorRange ()
 Destructor. More...
 
 WIteratorRange (WIteratorRange const &range)
 Copy constructor. More...
 
WIteratorRangeoperator= (WIteratorRange const &range)
 Assignment. More...
 
IteratorType const & begin () const
 Returns the begin of the range. More...
 
IteratorType const & end () const
 Returns the end of the range. More...
 

Private Member Functions

 WIteratorRange ()
 The standard constructor is not allowed. More...
 

Private Attributes

IteratorType m_begin
 The begin of the range. More...
 
IteratorType m_end
 The end of the range. More...
 

Detailed Description

template<typename IteratorType>
class WIteratorRange< IteratorType >

A range of iterators.

Stores a begin and an end iterator to define a range for iteration.

Template Parameters
IteratorTypeThe type of the iterators to store.

Definition at line 40 of file WIteratorRange.h.

Constructor & Destructor Documentation

◆ WIteratorRange() [1/3]

template<typename IteratorType >
WIteratorRange< IteratorType >::WIteratorRange ( IteratorType const &  begin,
IteratorType const &  end 
)

Construct a range from a begin and end iterator.

Parameters
beginThe iterator to act as the begin iterator.
endThe iterator to act as the end iterator.

Definition at line 99 of file WIteratorRange.h.

◆ ~WIteratorRange()

template<typename IteratorType >
WIteratorRange< IteratorType >::~WIteratorRange

Destructor.

Definition at line 106 of file WIteratorRange.h.

◆ WIteratorRange() [2/3]

template<typename IteratorType >
WIteratorRange< IteratorType >::WIteratorRange ( WIteratorRange< IteratorType > const &  range)

Copy constructor.

Parameters
rangeThe range to copy from.

Definition at line 111 of file WIteratorRange.h.

◆ WIteratorRange() [3/3]

template<typename IteratorType >
WIteratorRange< IteratorType >::WIteratorRange ( )
private

The standard constructor is not allowed.

Member Function Documentation

◆ begin()

template<typename IteratorType >
IteratorType const & WIteratorRange< IteratorType >::begin

Returns the begin of the range.

Returns
The begin iterator.

Definition at line 130 of file WIteratorRange.h.

Referenced by WIteratorRangeUnpacker< IteratorType >::operator=().

+ Here is the caller graph for this function:

◆ end()

template<typename IteratorType >
IteratorType const & WIteratorRange< IteratorType >::end

Returns the end of the range.

Returns
The end iterator.

Definition at line 136 of file WIteratorRange.h.

Referenced by WIteratorRangeUnpacker< IteratorType >::operator=().

+ Here is the caller graph for this function:

◆ operator=()

template<typename IteratorType >
WIteratorRange< IteratorType > & WIteratorRange< IteratorType >::operator= ( WIteratorRange< IteratorType > const &  range)

Assignment.

Parameters
rangeThe range to assign from.
Returns
*this

Definition at line 118 of file WIteratorRange.h.

References WIteratorRange< IteratorType >::m_begin, and WIteratorRange< IteratorType >::m_end.

Member Data Documentation

◆ m_begin

template<typename IteratorType >
IteratorType WIteratorRange< IteratorType >::m_begin
private

The begin of the range.

Definition at line 92 of file WIteratorRange.h.

Referenced by WIteratorRange< IteratorType >::operator=().

◆ m_end

template<typename IteratorType >
IteratorType WIteratorRange< IteratorType >::m_end
private

The end of the range.

Definition at line 95 of file WIteratorRange.h.

Referenced by WIteratorRange< IteratorType >::operator=().


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