FRAMES NO FRAMES

Class IloResourceParam

Definition file: ilsched/iloresourceparam.h
Include file: <ilsched/iloscheduler.h>

Parameters are used to change the default behavior of activities and resources.

Several kinds of constraints can be posted on a resource:

Instances of IloResourceParam are used to specify whether and how these constraints posted on resources must be taken into account during the search.

This class inherits from the IBM® ILOG® Concert Technology class IloExtractable. That class is documented in the IBM ILOG Concert Technology Reference Manual.

For more information, see Calendars, Parameter Classes, Temporal Relations, Parameters Organized by Function, Resource Usage Profiles, Transition Costs, Transition Times, and Resource Enforcement as Global Constraint Declaration.

See Also:

Constructor Summary
public IloResourceParam()
public IloResourceParam(IloResourceParamI * impl)
public IloResourceParam(const IloEnv env, const char * name=0)
Method Summary
public IloBoolareCalendarConstraintsIgnored() const
public IloBoolareCapacityConstraintsIgnored() const
public IloBoolarePrecedenceConstraintsIgnored() const
public IloBoolareSequenceConstraintsIgnored() const
public IloBoolareTransitionTimeConstraintsIgnored() const
public IloEnforcementLevelgetCalendarEnforcement() const
public IloEnforcementLevelgetCapacityEnforcement() const
public IloEnforcementLevelgetDurationEnforcement() const
public IloResourceParamI *getImpl() const
public IloEnforcementLevelgetPrecedenceEnforcement() const
public IloEnforcementLevelgetSequenceEnforcement() const
public IloEnforcementLevelgetTransitionTimeEnforcement() const
public voidignoreCalendarConstraints(IloBool ignore=IloTrue) const
public voidignoreCapacityConstraints(IloBool ignore=IloTrue) const
public voidignorePrecedenceConstraints(IloBool ignore=IloTrue) const
public voidignoreSequenceConstraints(IloBool ignore=IloTrue) const
public voidignoreTransitionTimeConstraints(IloBool ignore=IloTrue) const
public IloBoolisKeptOpen() const
public voidkeepOpen(IloBool open=IloTrue) const
public voidsetCalendarEnforcement(IloEnforcementLevel level) const
public voidsetCapacityEnforcement(IloEnforcementLevel level) const
public voidsetDurationEnforcement(IloEnforcementLevel level) const
public voidsetPrecedenceEnforcement(IloEnforcementLevel level) const
public voidsetSequenceEnforcement(IloEnforcementLevel level) const
public voidsetTransitionTimeEnforcement(IloEnforcementLevel level) const
Constructor Detail

IloResourceParam

public IloResourceParam()
This constructor creates an instance that is empty, that is, one whose handle pointer is null. You must assign it a value before you access it. Any attempt to access it before assignment leads to undefined behaviour.

IloResourceParam

public IloResourceParam(IloResourceParamI * impl)
This constructor creates an instance of the handle class from the pointer to an instance of the implementation class.

IloResourceParam

public IloResourceParam(const IloEnv env, const char * name=0)

This constructor creates a new instance of IloResourceParam in the given environment env.


Method Detail

areCalendarConstraintsIgnored

public IloBool areCalendarConstraintsIgnored() const

This member function returns IloTrue if the calendar of the resources depending on this parameter is to be ignored. Otherwise, it returns IloFalse.


areCapacityConstraintsIgnored

public IloBool areCapacityConstraintsIgnored() const

This member function returns IloTrue if the usage of the resources depending on this parameter is to be ignored. Otherwise, it returns IloFalse.


arePrecedenceConstraintsIgnored

public IloBool arePrecedenceConstraintsIgnored() const

This member function returns IloTrue if the precedence relations defined on the resources depending on this parameter are to be ignored. Otherwise, it returns IloFalse. Precedence relations are expressed with the member function IloResourceConstraint::setSuccessor.


areSequenceConstraintsIgnored

public IloBool areSequenceConstraintsIgnored() const

This member function returns IloTrue if the sequencing relations defined on the resources depending on this parameter are to be ignored. Otherwise, it returns IloFalse. Sequencing relations are expressed with the following member functions: IloResourceConstraint::setNext, IloResourceConstraint::setNotNext, IloResourceConstraint::setSetup, IloResourceConstraint::setNotSetup, IloResourceConstraint::setTeardown, and IloResourceConstraint::setNotTeardown.


areTransitionTimeConstraintsIgnored

public IloBool areTransitionTimeConstraintsIgnored() const

This member function returns IloTrue if the transition time defined on the resources depending on this parameter is to be ignored. Otherwise, it returns IloFalse.


getCalendarEnforcement

public IloEnforcementLevel getCalendarEnforcement() const

This member function returns the enforcement level for calendar constraint of the invoking parameter. See also: IloResourceParam::getCalendarEnforcement


getCapacityEnforcement

public IloEnforcementLevel getCapacityEnforcement() const

This member function returns the capacity enforcement level of the invoking parameter. See also: IloResourceParam::setCapacityEnforcement


getDurationEnforcement

public IloEnforcementLevel getDurationEnforcement() const

This member function returns the enforcement level on the duration of the invoking parameter. See also: IloResourceParam::setDurationEnforcement


getImpl

public IloResourceParamI * getImpl() const
This member function returns a pointer to the implementation object of the invoking handle.

getPrecedenceEnforcement

public IloEnforcementLevel getPrecedenceEnforcement() const

This member function returns the enforcement level for precedence relations of the invoking parameter. See also: IloResourceParam::setPrecedenceEnforcement


getSequenceEnforcement

public IloEnforcementLevel getSequenceEnforcement() const

This member function returns the enforcement level for sequencing relations of the invoking parameter. See also: IloResourceParam::setSequenceEnforcement


getTransitionTimeEnforcement

public IloEnforcementLevel getTransitionTimeEnforcement() const

This member function returns the enforcement level for transition time relations of the invoking parameter. See also: IloResourceParam::setTransitionTimeEnforcement


ignoreCalendarConstraints

public void ignoreCalendarConstraints(IloBool ignore=IloTrue) const

This member function allows you to specify whether the calendar constraints of the resources depending on this parameter will be ignored. If the argument ignored is equal to IloTrue, it will behave as if no calendar is attached to the resources depending on this parameter.


ignoreCapacityConstraints

public void ignoreCapacityConstraints(IloBool ignore=IloTrue) const

This member function allows you to specify whether the capacity or state constraints on the resources depending on this parameter will be ignored. If the argument ignore is equal to IloTrue, and the resource is a capacity resource, it will behave as if the capacity constraints on the resource are ignored. If the resource is a state resource, it will behave as if the required state constraints on the resource are ignored.


ignorePrecedenceConstraints

public void ignorePrecedenceConstraints(IloBool ignore=IloTrue) const

This member function allows you to specify whether the precedence relations defined on the resources depending on this parameter will be ignored. If the argument ignore is equal to IloTrue, it will behave as if the precedence relations are ignored. Precedence relations are expressed with the member function IloResourceConstraint::setSuccessor.


ignoreSequenceConstraints

public void ignoreSequenceConstraints(IloBool ignore=IloTrue) const

This member function allows you to specify whether the sequence relations defined on the resources depending on this parameter will be ignored. If the argument ignore is equal to IloTrue, it will behave as if the sequence relations are ignored. Sequence relations are expressed with the member functions IloResourceConstraint::setNext and IloResourceConstraint::setNotNext.


ignoreTransitionTimeConstraints

public void ignoreTransitionTimeConstraints(IloBool ignore=IloTrue) const

This member function allows you to specify whether the transition times defined on the resources depending on this parameter will be ignored. If the argument ignore is equal to IloTrue, it will behave as if the transition time constraints are ignored.


isKeptOpen

public IloBool isKeptOpen() const

This member function returns IloTrue if the resource depending on this parameter should be kept open. Otherwise, it returns IloFalse. See also: IloResourceParam::keepOpen


keepOpen

public void keepOpen(IloBool open=IloTrue) const

If the argument open is equal to IloTrue, this member function states that the resources depending on this parameter must be kept open when starting to solve the problem. It means that additional activities requiring or providing these resources may be added during solving. Otherwise, if the argument open is equal to IloFalse, it states that all the activities requiring or providing the resources depending on this parameter are known before starting to solve the problem. By default, it is supposed that all the activities requiring or providing the resources are known before starting to solve the problem.


setCalendarEnforcement

public void setCalendarEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the calendar of the resources. The level of enforcement of calendar constraints describes how the solver will enforce these calendar constraints. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.


setCapacityEnforcement

public void setCapacityEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the usage of the resources depending on this parameter. The level of enforcement of resource usage describes how the solver will enforce this resource usage. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.


setDurationEnforcement

public void setDurationEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the duration of activities using the resources depending on this parameter. The level of enforcement describes how the solver will enforce these durations. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.


setPrecedenceEnforcement

public void setPrecedenceEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the precedence relations defined on the resources depending on this parameter. Precedence relations can be expressed with the member function IloResourceConstraint::setSuccessor. The level of enforcement of precedence relations describes how the solver will enforce these constraints. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.


setSequenceEnforcement

public void setSequenceEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the sequencing relations defined on the resources depending on this parameter. Sequencing relations are expressed by the member functions IloResourceConstraint::setNext and IloResourceConstraint::setNotNext. The level of enforcement of sequencing relations describes how the solver will enforce these relations. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.


setTransitionTimeEnforcement

public void setTransitionTimeEnforcement(IloEnforcementLevel level) const

This member function allows specifying an enforcement level for the transition times defined on the resources depending on this parameter. Transition times can be associated with a resource with the member functions of the class IloTransitionTime. The level of enforcement of transition times describes how the solver will enforce these relations. The semantics of these levels is solver dependent. The default enforcement level is IloBasic. For more information on the enforcement levels and how they are interpreted in Scheduler Engine, see IloEnforcementLevel and Resource Enforcement as Global Constraint Declaration.