Class IloCalendar

Definition file: ilsched/ilocalendar.h

An instance of IloCalendar allows modeling complex behavior for activity variables (start, end, duration and processing time) within a resource. This behaviour could represent, for example, holidays, resource performances, and so forth. For more information, see Calendars. A calendar object is defined by three components:

A set of breaks which basically can suspend the execution of the concerned activity (see Calendars)
A set of shifts which can, for example, forbid some start dates (see Shift Object Semantic)
A granular step-wise function to define the efficiency of the resource along the schedule (see Functional and Integral Constraints on Resources)

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

Method Summary
`public void`	`addShiftObject(IloShiftObject shift) const`
`public IloBool`	`areShiftObjectsIgnored() const`
`public IloCalendarI *`	`getImpl() const`
`public IloBool`	`hasBreakListParam() const`
`public IloBool`	`hasEfficiencyParam() const`
`public IloBool`	`hasShiftObject() const`
`public void`	`ignoreBreakListParam(IlcBool ignored=IloTrue) const`
`public void`	`ignoreEfficiencyParam(IlcBool ignored=IloTrue) const`
`public void`	`ignoreShiftObjects(IlcBool ignored=IloTrue) const`
`public IloBool`	`isBreakListParamIgnored() const`
`public IloBool`	`isEfficiencyParamIgnored() const`
`public void`	`removeShiftObject(IloShiftObject shift) const`
`public void`	`setBreakListParam(const IloIntervalList breakList) const`
`public void`	`setEfficiencyParam(const IloGranularFunction f) const`

Inner Class
IloCalendar::ShiftObjectIterator

Constructor Detail

IloCalendar

public IloCalendar()

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.

IloCalendar

public IloCalendar(IloCalendarI * impl)

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

IloCalendar

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

This constructor creates a new instance of IloCalendar. Its name is set to name

Method Detail

addShiftObject

public void addShiftObject(IloShiftObject shift) const

This member function adds the shift object shift to the invoking calendar.

areShiftObjectsIgnored

public IloBool areShiftObjectsIgnored() const

This member function returns IloTrue if shift objects of the invoking calendar are not taken into account when searching for a solution. Otherwise, it returns IloFalse.

getImpl

public IloCalendarI * getImpl() const

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

hasBreakListParam

public IloBool hasBreakListParam() const

This member function returns IloTrue if a list of breaks has been attached to the invoking calendar. Otherwise, it returns IloFalse.

hasEfficiencyParam

public IloBool hasEfficiencyParam() const

This member function returns IloTrue if an efficiency function has been attached to the invoking calendar. Otherwise, it returns IloFalse.

hasShiftObject

public IloBool hasShiftObject() const

This member function returns IlcTrue if the invoking calendar contains shift objects. If the calendar list of shift object is empty, it returns IlcFalse.

ignoreBreakListParam

public void ignoreBreakListParam(IlcBool ignored=IloTrue) const

When the argument ignored is equal to IloTrue, this member function inhibits breaks for the invoking calendar. That is, all breaks will be ignored.

ignoreEfficiencyParam

public void ignoreEfficiencyParam(IlcBool ignored=IloTrue) const

When the argument ignored is equal to IloTrue, this member function inhibits the efficiency behavior for the invoking calendar. That is, the efficiency function is considered as equal to the granularity on the entire horizon.

ignoreShiftObjects

public void ignoreShiftObjects(IlcBool ignored=IloTrue) const

When the argument ignored is equal to IloTrue, this member function inhibits all shift objects added to the invoking calendar. That is, no shift is taken into account when searching for a solution.

isBreakListParamIgnored

public IloBool isBreakListParamIgnored() const

This member function returns IloTrue if breaks of the invoking calendar are not taken into account when searching for a solution. Otherwise, it returns IloFalse.

isEfficiencyParamIgnored

public IloBool isEfficiencyParamIgnored() const

This member function returns IloTrue if the efficiency of the invoking calendar is not taken into account when searching for a solution. Otherwise, it returns IloFalse.

removeShiftObject

public void removeShiftObject(IloShiftObject shift) const

This member function removes the shift object shift from the invoking calendar.

setBreakListParam

public void setBreakListParam(const IloIntervalList breakList) const

This member function sets breakList as the new break list of the calendar.

setEfficiencyParam

public void setEfficiencyParam(const IloGranularFunction f) const

This member function sets f as the granular step-wise function that models the efficiency of the calendar within the schedule.