afl::Iterator Class Reference

#include <iterator.h>

List of all members.

Public Member Functions
	Iterator (const Iterator &toCopy)
Iterator &	operator= (const Iterator &toCopy)
Iterator &	operator++ ()
Iterator	operator++ (int ignored)
Iterator	operator-- (int ignored)
Iterator &	operator-- ()
Iterator &	operator+= (ptrdiff_t a)
Iterator &	operator-= (ptrdiff_t a)
Iterator	operator+ (ptrdiff_t a) const
Iterator	operator- (ptrdiff_t a) const
ptrdiff_t	operator- (const Iterator &i) const
bool	operator== (const Iterator &toCompare) const
bool	operator!= (const Iterator &toCompare) const
bool	operator< (const Iterator &toCompare) const
bool	operator> (const Iterator &toCompare) const
bool	operator<= (const Iterator &toCompare) const
bool	operator>= (const Iterator &toCompare) const
Value	get (aspectid_t aspect=afl::FIELD_NONE) const
Protected Member Functions
	Iterator (const Field *field, size_t loc)
Friends
Iterator	operator+ (ptrdiff_t a, const Iterator &i)

---

Detailed Description

class Iterator an iterator that iterates over the properties of a propertyset Note that iterators don't respect field boundaries

---

Constructor & Destructor Documentation

afl::Iterator::Iterator (  const Iterator &  toCopy  )

Parameters: toCopy  the iterator to copy

afl::Iterator::Iterator (  const Field *  field, size_t  loc )  [protected]

constructs a new iterator Parameters: field  the parent that contains the relevant properties etc. loc  the starting location of the iterator

---

Member Function Documentation

Value afl::Iterator::get (  aspectid_t  aspect = afl::FIELD_NONE  )  const

Parameters: aspect  the aspect to get, if no aspect is specified then the value of the field is assumed. Other permissable values are: afl::FIELD_X and afl::FIELD_DX. Exceptions: ddf::OutOfBoundsException  If afl::FIELD_DX is passed and the field contains no derivative information or if the iterator is not pointing at a valid point in the field Returns: the requested value at the current point

bool afl::Iterator::operator!= (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  another iterator to compare this one to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

Iterator afl::Iterator::operator+ (  ptrdiff_t  a  )  const

produce a new iterator that is more advanced than this one Parameters: a  how many positions more advanced will the iterator be Returns: a new iterator more advanced by a than this one

Iterator afl::Iterator::operator++ (  int  ignored  )

postfix increment

Iterator& afl::Iterator::operator++ (   )

prefix increment

Iterator& afl::Iterator::operator+= (  ptrdiff_t  a  )

advance by some Parameters: a  how many positions to advance the iterator by Returns: a reference to this iterator afte the advancement

ptrdiff_t afl::Iterator::operator- (  const Iterator &  i  )  const

Returns: how many positions is this iterator more advanced than than another one Parameters: i  the iterator to compare this one with. Exceptions: ddf::InvalidArgumentException  if the iterators are not pointing at the same field

Iterator afl::Iterator::operator- (  ptrdiff_t  a  )  const

produce a new iterator that is less advanced than this one Parameters: a  how many positions less advanced will the iterator be Returns: a new iterator less advanced by a than this one

Iterator& afl::Iterator::operator-- (   )

prefix decrement

Iterator afl::Iterator::operator-- (  int  ignored  )

decrements the position of this iterator Parameters: ignored  ignored

Iterator& afl::Iterator::operator-= (  ptrdiff_t  a  )

recede by some Parameters: a  how many positions to recede the iterator by Returns: a reference to this iterator afte the retraction

bool afl::Iterator::operator< (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  another iterator to compare this one to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

bool afl::Iterator::operator<= (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  another iterator to compare this one to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

Iterator& afl::Iterator::operator= (  const Iterator &  toCopy  )

Parameters: toCopy  the iterator this iterataor will mimic

bool afl::Iterator::operator== (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  the iterataor to compare tthis onehis iterator to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

bool afl::Iterator::operator> (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  another iterator to compare this one to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

bool afl::Iterator::operator>= (  const Iterator &  toCompare  )  const

compares this isterator with another Parameters: toCompare  another iterator to compare this one to Exceptions: ddf::InvalidArgumentException  if the two iterators to compare are from different fields

---

Friends And Related Function Documentation

Iterator operator+ (  ptrdiff_t  a, const Iterator &  i )  [friend]

produce a new iterator that is more advanced than another Parameters: a  how many positions more advanced will the iterator be i  the iterator the new iterator will be more advanced than Returns: a new iterator more advanced by a than i

---

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

• iterator.h

---