Skip to main content
FRAMES NO FRAMES

Class IlcRevAny

Definition file: ilcp/cpext.h
Include file: <ilcp/cpext.h>
Map of IlcRevAnyIlcRevAnyIlcRevAny
The reversible class for IlcAny values.

IlcRevAny is a reversible version of the basic predefined type, IlcAny. The reversible version makes it easier to restore a previous state. This class has a value data member corresponding to IlcAny. This value data member is automatically restored when CP Optimizer 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 IlcRevAny as automatic objects (that is, as objects allocated on the C++ stack). Do not pass them by value.

An object of the class IlcRevAny is automatically cast to the basic type IlcAny, 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 IlcRevAny behaves very much like an instance of IlcAny; the difference in their behavior has to do with assignments. Indeed, all reversible assignments are undone when CP Optimizer backtracks.

Unfortunately, the class IlcRevAny is not typed. The pointers are of type IlcAny and thus give no indication of the type of objects they point to.

For more information, see the concepts State in CP Optimizer and Reversibility in CP Optimizer.

See Also:

Method Summary
public IlcAnygetValue() const
public IlcRevAny(IlcCPEngine solver, IlcAny initValue=0)
public operator IlcAny() const
public voidsetValue(IlcCPEngine solver, IlcAny value)
Method Detail

IlcRevAny

public IlcRevAny(IlcCPEngine solver, IlcAny initValue=0)

The constructor creates a new object, an instance of IlcRevAny.


getValue

public IlcAny getValue() const

This member function accesses the value of the invoking instance of IlcRevAny.


operator IlcAny

public operator IlcAny() const

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


setValue

public void setValue(IlcCPEngine solver, IlcAny value)

This member function modifies the value of the invoking object by reversibly assigning value to it. When CP Optimizer backtracks, this reversible modification will be undone.