FRAMES NO FRAMES

Class IloActivityBreakParam

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

Parameters are used to change the default behavior of activities and resources. By default when an activity is breakable, the minimum duration of its execution time is equal to one, only null duration breaks are considered as disjunctive, and the breakable activity cannot be suspended at its start or end time. Instances of IloActivityBreakParam are used to change these characteristics in order to control the way breakable activities are executed.

It is possible to specify the minimal duration of a breakable activity executed in several parts, the ability of a breakable activity to be suspended at its start or end time, and to define the set of disjunctive breaks for activities.

This parameter has no effect on activities that are not breakable.

For more information, see Calendars and Parameter Classes.

See Also:

Constructor Summary
public IloActivityBreakParam()
public IloActivityBreakParam(IloActivityBreakParamI * impl)
public IloActivityBreakParam(const IloEnv env, const char * name=0)
Method Summary
public voidaddDisjunctiveBreakType(const IloIntSet types) const
public voidaddDisjunctiveBreakType(IloInt type) const
public IloBoolcanBeSuspendedAtEnd() const
public IloBoolcanBeSuspendedAtStart() const
public voidclearDisjunctiveBreakType() const
public IloNumgetDurationMaxNormalBreaks() const
public IloNumgetDurationMinNormalBreaks() const
public IloNumgetExecutionDurationMin() const
public IloActivityBreakParamI *getImpl() const
public IloBoolhasDisjunctiveBreakType() const
public IloBoolisDisjunctiveBreakType(IloInt type) const
public voidremoveDisjunctiveBreakType(const IloIntSet types) const
public voidremoveDisjunctiveBreakType(IloInt type) const
public voidsetCanBeSuspendedAtEnd(IloBool susp=IloTrue) const
public voidsetCanBeSuspendedAtStart(IloBool susp=IloTrue) const
public voidsetDurationMaxNormalBreaks(IloNum maxDurNormBreaks) const
public voidsetDurationMinNormalBreaks(IloNum minDurNormBreaks) const
public voidsetExecutionDurationMin(IloNum minExecutionTime) const
Constructor Detail

IloActivityBreakParam

public IloActivityBreakParam()
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.

IloActivityBreakParam

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

IloActivityBreakParam

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

This constructor creates an instance of IloActivityBreakParam with the default values that the duration of its execution time is equal to one, no breaks are considered as disjunctive, and breakable activities cannot be suspended at their start and end times.


Method Detail

addDisjunctiveBreakType

public void addDisjunctiveBreakType(const IloIntSet types) const

This member function adds the set of types types to the set of disjunctive break types of the invoking parameter.


addDisjunctiveBreakType

public void addDisjunctiveBreakType(IloInt type) const

This member function adds the type type to the set of disjunctive break types of the invoking parameter.


canBeSuspendedAtEnd

public IloBool canBeSuspendedAtEnd() const

This member function returns IloTrue if the activity using the invoking parameter can be suspended at its end time. Otherwise, it returns IloFalse.


canBeSuspendedAtStart

public IloBool canBeSuspendedAtStart() const

This member function returns IloTrue if the activity using the invoking parameter can be suspended at its start time. Otherwise, it returns IloFalse.


clearDisjunctiveBreakType

public void clearDisjunctiveBreakType() const

This member function empties the set of disjunctive break types of activity using the invoking parameter.


getDurationMaxNormalBreaks

public IloNum getDurationMaxNormalBreaks() const

This member function returns the threshold duration above which all breaks are considered as disjunctive.


getDurationMinNormalBreaks

public IloNum getDurationMinNormalBreaks() const

This member function returns the threshold duration under which all breaks are considered as disjunctive. By default, the value of this minimal duration is 1 (one) so that only the breaks with null duration are considered as disjunctive.


getExecutionDurationMin

public IloNum getExecutionDurationMin() const

A breakable activity may execute during a set of disjoint temporal intervals. These execution intervals are separated by intervals that correspond to the breaks that suspend the activity. This member function returns the minimal duration for the execution intervals of the activities using the invoking parameter.

The default minimal duration is 1 (one). It can be redefined by calling the member function setExecutionDurationMin.


getImpl

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

hasDisjunctiveBreakType

public IloBool hasDisjunctiveBreakType() const

This member function returns IloTrue if the set of disjunctive break types of the invoking parameter is not empty. Otherwise, it returns IloFalse.


isDisjunctiveBreakType

public IloBool isDisjunctiveBreakType(IloInt type) const

This member function returns IloTrue if the type type belongs to the set of disjunctive break types of the invoking activity. Otherwise, it returns IloFalse.


removeDisjunctiveBreakType

public void removeDisjunctiveBreakType(const IloIntSet types) const

This member function removes the set of types types from the set of disjunctive break types of the invoking parameter.


removeDisjunctiveBreakType

public void removeDisjunctiveBreakType(IloInt type) const

This member function removes type from the set of disjunctive break types of the invoking parameter.


setCanBeSuspendedAtEnd

public void setCanBeSuspendedAtEnd(IloBool susp=IloTrue) const

If susp is equal to IloTrue, this member function permits the activity using the invoking parameter to be suspended at its end time. Otherwise, these activities cannot be suspended at its end time.


setCanBeSuspendedAtStart

public void setCanBeSuspendedAtStart(IloBool susp=IloTrue) const

If susp is equal to IloTrue, this member function permits the activity using the invoking parameter to be suspended at its start time. Otherwise, these activities cannot be suspended at its start time.


setDurationMaxNormalBreaks

public void setDurationMaxNormalBreaks(IloNum maxDurNormBreaks) const

This member function states that the invoking activity must be completely processed either before or after any break whose duration is strictly greater than maxDurNormBreaks.

Increasing this maximal duration has no effect in search mode.


setDurationMinNormalBreaks

public void setDurationMinNormalBreaks(IloNum minDurNormBreaks) const

This member function states that the invoking activity must be completely processed either before or after any break whose duration is strictly lower than minDurNormBreaks.

By default, the value of this minimal duration for a breakable activity is 1 (one) so that only the breaks with null duration are considered disjunctive.

Decreasing this minimal duration has no effect in search mode.


setExecutionDurationMin

public void setExecutionDurationMin(IloNum minExecutionTime) const

A breakable activity may execute during a set of disjoint temporal intervals. These execution intervals are separated by intervals that correspond to the breaks that suspend the activity.

This member function states that the duration of the temporal intervals during which the invoking breakable activity executes must all be greater or equal to minExecutionTime. Note that minExecutionTime must be a strictly positive integer. By default, the minimal duration for execution intervals is 1.

Decreasing the minimal duration for execution intervals has no effect in search mode.