Class IloActivityOverlapParam

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 cannot overlap breaks. Instances of IloActivityOverlapParam are used to specify in which conditions an activity can overlap breaks.

A break overlap variable allows an activity to start or to finish processing inside some special breaks (called "possibly overlapped breaks"), and allows posting constraints on possible overlap duration.

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.

See Also:

IloActivity, IloSchedulerEnv

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

Method Summary
`public void`	`addEndBreakOverlapType(const IloIntSet types) const`
`public void`	`addEndBreakOverlapType(IloInt type) const`
`public void`	`addStartBreakOverlapType(const IloIntSet types) const`
`public void`	`addStartBreakOverlapType(IloInt type) const`
`public void`	`clearEndBreakOverlapType() const`
`public void`	`clearStartBreakOverlapType() const`
`public IloNum`	`getEndBreakOverlapMax() const`
`public IloNum`	`getEndBreakOverlapMin() const`
`public IloActivityOverlapParamI *`	`getImpl() const`
`public IloNum`	`getStartBreakOverlapMax() const`
`public IloNum`	`getStartBreakOverlapMin() const`
`public IloBool`	`hasEndBreakOverlapType() const`
`public IloBool`	`hasStartBreakOverlapType() const`
`public IloBool`	`isEndBreakOverlapType(IloInt type) const`
`public IloBool`	`isStartBreakOverlapType(IloInt type) const`
`public void`	`removeEndBreakOverlapType(const IloIntSet types) const`
`public void`	`removeEndBreakOverlapType(IloInt type) const`
`public void`	`removeStartBreakOverlapType(const IloIntSet types) const`
`public void`	`removeStartBreakOverlapType(IloInt type) const`
`public void`	`setEndBreakOverlapMax(IloNum endOverlapMax) const`
`public void`	`setEndBreakOverlapMin(IloNum endOverlapMin) const`
`public void`	`setStartBreakOverlapMax(IloNum startOverlapMax) const`
`public void`	`setStartBreakOverlapMin(IloNum startOverlapMin) const`

Constructor Detail

IloActivityOverlapParam

public IloActivityOverlapParam()

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.

IloActivityOverlapParam

public IloActivityOverlapParam(IloActivityOverlapParamI * impl)

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

IloActivityOverlapParam

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

This constructor creates a new instance of IloActivityOverlapParam with the default values that an activity cannot overlap breaks at start and end times.

Method Detail

addEndBreakOverlapType

public void addEndBreakOverlapType(const IloIntSet types) const

This member function adds the set of types types to the set of end break overlap types.

addEndBreakOverlapType

public void addEndBreakOverlapType(IloInt type) const

This member function adds the type type to the set of end break overlap types.

addStartBreakOverlapType

public void addStartBreakOverlapType(const IloIntSet types) const

This member function adds the set of types types to the set of start break overlap types.

addStartBreakOverlapType

public void addStartBreakOverlapType(IloInt type) const

This member function adds the type type to the set of start break overlap types.

clearEndBreakOverlapType

public void clearEndBreakOverlapType() const

This member function empties the set of end break overlap types.

clearStartBreakOverlapType

public void clearStartBreakOverlapType() const

This member function empties the set of start break overlap types.

getEndBreakOverlapMax

public IloNum getEndBreakOverlapMax() const

This member function returns the maximal value of the end break overlap variable of the activities depending on the invoking parameter.

getEndBreakOverlapMin

public IloNum getEndBreakOverlapMin() const

This member function returns the minimal value of the end break overlap variable of the activities depending on the invoking parameter.

getImpl

public IloActivityOverlapParamI * getImpl() const

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

getStartBreakOverlapMax

public IloNum getStartBreakOverlapMax() const

This member function returns the maximal value of the start break overlap variable of the activities depending on the invoking parameter.

getStartBreakOverlapMin

public IloNum getStartBreakOverlapMin() const

This member function returns the minimal value of the start break overlap variable of the activities depending on the invoking parameter.

hasEndBreakOverlapType

public IloBool hasEndBreakOverlapType() const

This member function returns IloTrue if the set of end break overlap types of the invoking parameter is not empty.

hasStartBreakOverlapType

public IloBool hasStartBreakOverlapType() const

This member function returns IloTrue if the set of start break overlap types of the invoking parameter is not empty.

isEndBreakOverlapType

public IloBool isEndBreakOverlapType(IloInt type) const

This member function returns IloTrue if the type type belongs to the set of end break overlap types of the invoking parameter.

isStartBreakOverlapType

public IloBool isStartBreakOverlapType(IloInt type) const

This member function returns IloTrue if the type type belongs to the set of start break overlap types of the invoking parameter.

removeEndBreakOverlapType

public void removeEndBreakOverlapType(const IloIntSet types) const

This function removes the set of types types from the set of end break overlap types.

removeEndBreakOverlapType

public void removeEndBreakOverlapType(IloInt type) const

This member function removes the type type from the set of end break overlap types.

removeStartBreakOverlapType

public void removeStartBreakOverlapType(const IloIntSet types) const

This function removes the set of types types from the set of start break overlap types.

removeStartBreakOverlapType

public void removeStartBreakOverlapType(IloInt type) const

This function removes the type type from the set of start break overlap types.

setEndBreakOverlapMax

public void setEndBreakOverlapMax(IloNum endOverlapMax) const

This member function sets endOverlapMax as the new maximal value of the end break overlap variable.

setEndBreakOverlapMin

public void setEndBreakOverlapMin(IloNum endOverlapMin) const

This member function sets endOverlapMin as the new minimal value of the end break overlap variable.

setStartBreakOverlapMax

public void setStartBreakOverlapMax(IloNum startOverlapMax) const

This member function sets startOverlapMax as the new maximal value of the start break overlap variable.

setStartBreakOverlapMin

public void setStartBreakOverlapMin(IloNum startOverlapMin) const

This member function sets startOverlapMin as the new minimal value of the start break overlap variable.