All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends
Public Member Functions | Protected Attributes
face_contour_detector::ParallelParameterIterator< T > Class Template Reference

Allows to define a iterator which iterates multiple values of the type T in parallel. This means that every value pointer that has been added will be increased by the stepSize at the same time if Next() is being called. More...

#include <ParameterIterator.h>

Inheritance diagram for face_contour_detector::ParallelParameterIterator< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void Add (T *target)
 Adds a pointer to a value (the value will be modified, if Next(), or Reset() will be called)
virtual bool HasNext ()
virtual void Next ()
 Adds the stepSize to all values that have been added.
 ParallelParameterIterator (T start, T end, T stepSize)
 ParallelParameterIterator (const ParallelParameterIterator &other)
virtual void PrintValue ()
 Prints the value to std::cout.
virtual void Reset ()
 Resets all values back to the start value.

Protected Attributes

T m_end
T m_start
T m_stepSize
std::vector< T * > m_targets

Detailed Description

template<class T>
class face_contour_detector::ParallelParameterIterator< T >

Allows to define a iterator which iterates multiple values of the type T in parallel. This means that every value pointer that has been added will be increased by the stepSize at the same time if Next() is being called.

Definition at line 53 of file ParameterIterator.h.


Constructor & Destructor Documentation

template<class T >
face_contour_detector::ParallelParameterIterator< T >::ParallelParameterIterator ( T  start,
T  end,
T  stepSize 
)

Constructor

Parameters:
startthe start value (will be set if Reset() is beeing called)
endif a value becomes bigger or equal than this value, HasNext() will be false
stepSizethe stepsize is added to each value pointer when Next() is called.

Definition at line 113 of file ParameterIterator.h.

Definition at line 117 of file ParameterIterator.h.


Member Function Documentation

template<class T >
void face_contour_detector::ParallelParameterIterator< T >::Add ( T target) [virtual]

Adds a pointer to a value (the value will be modified, if Next(), or Reset() will be called)

Definition at line 154 of file ParameterIterator.h.

template<class T >
bool face_contour_detector::ParallelParameterIterator< T >::HasNext ( ) [virtual]

Returns true if Next() can be called again if one or more of the values is >= end, HasNext() returns false, otherwise HasNext() returns true

Returns:
true if there is a next value

Implements face_contour_detector::ParameterIteratorI.

Definition at line 129 of file ParameterIterator.h.

template<class T >
void face_contour_detector::ParallelParameterIterator< T >::Next ( ) [virtual]

Adds the stepSize to all values that have been added.

Implements face_contour_detector::ParameterIteratorI.

Definition at line 121 of file ParameterIterator.h.

template<class T >
void face_contour_detector::ParallelParameterIterator< T >::PrintValue ( ) [virtual]

Prints the value to std::cout.

Implements face_contour_detector::ParameterIteratorI.

Definition at line 146 of file ParameterIterator.h.

template<class T >
void face_contour_detector::ParallelParameterIterator< T >::Reset ( ) [virtual]

Resets all values back to the start value.

Implements face_contour_detector::ParameterIteratorI.

Definition at line 139 of file ParameterIterator.h.


Member Data Documentation

template<class T>
T face_contour_detector::ParallelParameterIterator< T >::m_end [protected]

Definition at line 76 of file ParameterIterator.h.

template<class T>
T face_contour_detector::ParallelParameterIterator< T >::m_start [protected]

Definition at line 75 of file ParameterIterator.h.

Definition at line 77 of file ParameterIterator.h.

Definition at line 78 of file ParameterIterator.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends


face_contour_detector
Author(s): Fabian Wenzelmann and Julian Schmid
autogenerated on Wed Dec 26 2012 16:18:17