MoveIterator Class Reference

#include <MoveIterator.h>

Collaboration diagram for MoveIterator:

[legend]

Public Member Functions
	MoveIterator ()
	Default constructor.
virtual	~MoveIterator ()
	Empty destructor.
MoveIterator &	operator= (const MoveIterator &m)
	Affectation operator.
bool	operator== (const MoveIterator &m) const
	Equality test.
bool	operator< (const MoveIterator &m) const
	Inferiority test (for STL maps).
bool	operator!= (const MoveIterator &m) const
	Difference test.
MoveIterator &	operator++ ()
	Iteration.
move_command	operator * (void) const
	Dereference operator.
Move *	operator-> (void) const
	Operator to access properties of the movement referenced.
Protected Member Functions
	MoveIterator (Move *move)
	Private constructor.
Protected Attributes
Move *	_move
	The movement.
Friends
class	Move

---

Detailed Description

< An iterator on Move

Definition at line 35 of file MoveIterator.h.

---

Constructor & Destructor Documentation

MoveIterator::MoveIterator

(

Move *

move

)

[protected]

Private constructor.

Parameters:

move

Definition at line 35 of file MoveIterator.cpp.

                                      : _move(move) {

}

---

Member Function Documentation

MoveIterator & MoveIterator::operator=

(

const MoveIterator &

m

)

Affectation operator.

Parameters:

m

other iterator

Returns:

this iterator (modified)

Definition at line 43 of file MoveIterator.cpp.

References _move.

                                                           {
  _move = m._move;
  return (*this);
}

bool MoveIterator::operator==

(

const MoveIterator &

m

)

const

Equality test.

Parameters:

m

iterator to test

Returns:

true if m is the same iterator as the current one

Definition at line 48 of file MoveIterator.cpp.

References _move.

                                                          {
  return (_move == m._move);
}

bool MoveIterator::operator<

(

const MoveIterator &

m

)

const

Inferiority test (for STL maps).

Parameters:

m

iterator to test

Returns:

true if m is the same iterator as the current one

Definition at line 52 of file MoveIterator.cpp.

                                                         {
  return (this->operator*() < m.operator*()); //Compares the handled movements
}

bool MoveIterator::operator!=

(

const MoveIterator &

m

)

const

Difference test.

Parameters:

m

iterator to test

Returns:

true if m is different from the current one

Definition at line 56 of file MoveIterator.cpp.

References _move.

                                                          {
  return (_move != m._move);
}

MoveIterator & MoveIterator::operator++

(

)

Iteration.

Returns:

this iterator (modified)

Definition at line 60 of file MoveIterator.cpp.

References _move, and Move::_next.

                                       {
  if(_move){
    _move = _move->_next;
  }
  return (*this);
}

move_command MoveIterator::operator *

(

void

)

const

Dereference operator.

Returns:

the move_command handled by the referenced movement

Definition at line 67 of file MoveIterator.cpp.

References _move, and Move::getHandledMovement().

                                               {
  return _move->getHandledMovement();
}

Here is the call graph for this function:

Move * MoveIterator::operator->

(

void

)

const

Operator to access properties of the movement referenced.

Returns:

the Move * referenced

Definition at line 71 of file MoveIterator.cpp.

References _move.

                                          {
  return _move;
}

---

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

• src/MoveIterator.h
• src/MoveIterator.cpp

---