Class IlcDiscreteEnergyIterator

Definition file: ilsched/energy.h

Include file: <ilsched/ilsched.h>

An instance of this class traverses the set of discrete energy resources.

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

Method Summary
`public IlcBool`	`ok() const`
`public IlcDiscreteEnergy`	`operator*() const`
`public IlcDiscreteEnergyIterator &`	`operator++()`

IlcDiscreteEnergyIterator

public IlcDiscreteEnergyIterator(const IlcSchedule schedule)

This constructor creates an iterator to traverse all the discrete energy resources 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 discrete resources have been scanned by the iterator.

operator*

public IlcDiscreteEnergy operator*() const

This operator accesses the instance of IlcDiscreteEnergy 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 IlcDiscreteEnergyIterator & operator++()

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