Class IlcReservoirIterator

Definition file: ilsched/reservoi.h

Include file: <ilsched/ilsched.h>

An instance of this class traverses the set of reservoirs.

Constructor and Destructor Summary
`public`	`IlcReservoirIterator(const IlcSchedule schedule)`

Method Summary
`public IlcBool`	`ok() const`
`public IlcReservoir`	`operator*() const`
`public IlcReservoirIterator &`	`operator++()`

IlcReservoirIterator

public IlcReservoirIterator(const IlcSchedule schedule)

This constructor creates an iterator to traverse all the reservoirs of schedule.

Method Detail

ok

public IlcBool ok() const

This member function returns IlcTrue if the current position of the iterator is a valid one. It returns IlcFalse if all the reservoirs have been scanned by the iterator.

operator*

public IlcReservoir operator*() const

This operator accesses the instance of IlcReservoir located at the current position of the iterator. If the iterator is set past the end position, this operator returns an empty handle.

operator++

public IlcReservoirIterator & operator++()

This left-increment operator shifts the current position of the iterator.