FRAMES NO FRAMES

Class IlcRevBool

Definition file: ilsolver/basic.h
Include file: <ilsolver/ilosolver.h>

IlcRevBool is a reversible version of the basic predefined Solver type, IlcBool. The reversible version makes it easier to restore a previous state. This class has a value data member corresponding to IlcBool. This value data member is automatically restored when Solver backtracks.

This class is not a handle class. Objects of this class should be used directly, that is, not through pointers to them. Do not create instances of IlcRevBool as automatic objects (that is, as objects allocated on the C++ stack). Do not pass them by value.

An object of the class IlcRevBool is automatically cast to the basic type IlcBool, if needed. Instances of this reversible class can be used as data members. However, do not use them as types for automatic variables, where “automatic” has its usual C++ meaning, as this practice would create memory-access errors. Do not pass them as arguments.

An instance of IlcRevBool behaves very much like an instance of IlcBool; the difference in their behavior has to do with assignments. Indeed, all reversible assignments are undone when Solver backtracks.

For more information, see the concepts State and Reversibility.

See Also:

Constructor Summary
public IlcRevBool(IloSolver solver, IlcBool initValue=IlcFalse)
Method Summary
public IlcBoolgetValue() const
public operator IlcBool() const
public voidsetValue(IloSolver solver, IlcBool value)
Constructor Detail

IlcRevBool

public IlcRevBool(IloSolver solver, IlcBool initValue=IlcFalse)

The constructor creates a new object, an instance of IlcRevBool. It is more memory-efficient than the constructor without arguments.


Method Detail

getValue

public IlcBool getValue() const

This member function accesses the value of the instance of IlcRevBool.


operator IlcBool

public operator IlcBool() const

This operator returns the value of the instance of IlcRevBool. In other words, this operator automatically casts an instance of IlcRevBool into an instance of IlcBool.


setValue

public void setValue(IloSolver solver, IlcBool value)

This operator modifies the value of an instance of IlcRevBool by assigning value to it. When Solver backtracks, this reversible modification will be undone.