Aikido
aikido::common::StepSequence::const_iterator Class Reference

#include <aikido/common/StepSequence.hpp>

Inheritance diagram for aikido::common::StepSequence::const_iterator:

Public Member Functions

double dereference () const
 Dereference implementation for boost::iterator_facade. More...
 
void increment ()
 Increment implementation for boost::iterator_facade. More...
 
bool equal (const StepSequence::const_iterator &other) const
 Equal implementation for boost::iterator_facade. More...
 

Private Member Functions

 const_iterator (const StepSequence &seq, std::size_t step)
 Private constructor that should always be constructed from StepSequence::begin(). More...
 

Private Attributes

const StepSequencemSeq
 StepSequence associated with this iterator. More...
 
std::size_t mStep
 Current step number. More...
 
double mValue
 Value of the current step. More...
 

Friends

class StepSequence
 

Constructor & Destructor Documentation

◆ const_iterator()

aikido::common::StepSequence::const_iterator::const_iterator ( const StepSequence seq,
std::size_t  step 
)
private

Private constructor that should always be constructed from StepSequence::begin().

Member Function Documentation

◆ dereference()

double aikido::common::StepSequence::const_iterator::dereference ( ) const

Dereference implementation for boost::iterator_facade.

◆ equal()

bool aikido::common::StepSequence::const_iterator::equal ( const StepSequence::const_iterator other) const

Equal implementation for boost::iterator_facade.

Returns
True if two iterators are at the same point in the sequence.

◆ increment()

void aikido::common::StepSequence::const_iterator::increment ( )

Increment implementation for boost::iterator_facade.

Friends And Related Function Documentation

◆ StepSequence

friend class StepSequence
friend

Member Data Documentation

◆ mSeq

const StepSequence& aikido::common::StepSequence::const_iterator::mSeq
private

StepSequence associated with this iterator.

◆ mStep

std::size_t aikido::common::StepSequence::const_iterator::mStep
private

Current step number.

◆ mValue

double aikido::common::StepSequence::const_iterator::mValue
private

Value of the current step.