Class IloActivityBasicParam

Definition file: ilsched/iloactivityparam.h

Include file: <ilsched/iloscheduler.h>

Parameters are used to change the default behavior of activities and resources. By default, an activity is not breakable, does not consider efficiency function of potential calendars, and no interval is ignored. With IloActivityBasicParam, it is (for example) possible to specify if an activity is breakable, or if an activity must take into account efficiency functions. IloActivityBasicParam also allows ignoring sets of interval types, such as breaks and shifts.

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, and Parameter Classes.

Constructor Summary
`public`	`IloActivityBasicParam()`
`public`	`IloActivityBasicParam(IloActivityBasicParamI * impl)`
`public`	`IloActivityBasicParam(const IloEnv env, const char * name=0)`

Method Summary
`public void`	`addIgnoredBreakType(const IloIntSet types) const`
`public void`	`addIgnoredBreakType(IloInt type) const`
`public void`	`clearIgnoredBreakType() const`
`public IloActivityBasicParamI *`	`getImpl() const`
`public IloBool`	`hasIgnoredBreakType() const`
`public IloBool`	`isBreakable() const`
`public IloBool`	`isIgnoredBreakType(IloInt type) const`
`public void`	`removeIgnoredBreakType(const IloIntSet types) const`
`public void`	`removeIgnoredBreakType(IloInt type) const`
`public void`	`setBreakable(IloBool breakable=IloTrue) const`
`public void`	`setUseEfficiency(IloBool useEfficiency=IloTrue) const`
`public IloBool`	`useEfficiency() const`

IloActivityBasicParam

public IloActivityBasicParam()

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.

IloActivityBasicParam

public IloActivityBasicParam(IloActivityBasicParamI * impl)

This constructor creates an instance of the handle class from the pointer to an instance of the implementation class.

IloActivityBasicParam

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

This constructor creates an instance of IloActivityBasicParam with the default values that an activity is not breakable, does not use efficiency, and there are no ignored breaks or shifts.

Method Detail

addIgnoredBreakType

public void addIgnoredBreakType(const IloIntSet types) const

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

addIgnoredBreakType

public void addIgnoredBreakType(IloInt type) const

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

clearIgnoredBreakType

public void clearIgnoredBreakType() const

This member function empties the set of ignored break types of the invoking parameter.

getImpl

public IloActivityBasicParamI * getImpl() const

This member function returns a pointer to the implementation object of the invoking handle.

hasIgnoredBreakType

public IloBool hasIgnoredBreakType() const

This member function returns IloTrue if the set of ignored break types is not empty.

isBreakable

public IloBool isBreakable() const

This member function returns IloTrue if the activities depending on this parameter are breakable. Otherwise, it returns IloFalse.

isIgnoredBreakType

public IloBool isIgnoredBreakType(IloInt type) const

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

removeIgnoredBreakType

public void removeIgnoredBreakType(const IloIntSet types) const

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

removeIgnoredBreakType

public void removeIgnoredBreakType(IloInt type) const

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

setBreakable

public void setBreakable(IloBool breakable=IloTrue) const

When breakable is equal to IloTrue, this member function states that activities depending on this parameter are breakable. Otherwise, they are not breakable.

setUseEfficiency

public void setUseEfficiency(IloBool useEfficiency=IloTrue) const

When the argument useEfficiency is equal to IloTrue, the processing time is computed using the efficiency function of resource calendars.

Note that if no calendar with an efficiency function is attached to resources or to resource constraints required by activities used by the invoking parameter, the processing time remains unbounded.

useEfficiency

public IloBool useEfficiency() const

This member function returns IloTrue if the processing time is computed using the efficiency function of resource calendars. Otherwise, it returns IloFalse.