Class IlcCalendar

Definition file: ilsched/sbecprop.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 and Destructor Summary
`public`	`IlcCalendar()`
`public`	`IlcCalendar(IlcCalendarI * impl)`
`public`	`IlcCalendar(const IlcSchedule schedule)`

Method Summary
`public void`	`addShiftObject(IlcShiftObject shiftObj)`
`public IlcIntervalList`	`getBreakList() const`
`public IlcGranularFunction`	`getEfficiency() const`
`public IlcCalendarI *`	`getImpl() const`
`public const char *`	`getName() const`
`public IlcAny`	`getObject() const`
`public IlcSchedule`	`getSchedule() const`
`public IloSolver`	`getSolver() const`
`public IloSolverI *`	`getSolverI() const`
`public void`	`operator=(const IlcCalendar & h)`
`public void`	`removeShiftObject(IlcShiftObject shiftObj)`
`public void`	`setBreakList(IlcIntervalList list)`
`public void`	`setEfficiency(IlcGranularFunction f)`
`public void`	`setName(const char * name) const`
`public void`	`setObject(IlcAny object) const`

Inner Class
IlcCalendar::ShiftObjectIterator

Constructor and Destructor Detail

IlcCalendar

public IlcCalendar()

This constructor creates an empty handle. You must initialize it before you use it.

IlcCalendar

public IlcCalendar(IlcCalendarI * impl)

This constructor creates a handle object from a pointer to an implementation object.

IlcCalendar

public IlcCalendar(const IlcSchedule schedule)

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

Method Detail

addShiftObject

public void addShiftObject(IlcShiftObject shiftObj)

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

getBreakList

public IlcIntervalList getBreakList() const

This member function returns the list of breaks attached to the invoking calendar, if such a list exists.

getEfficiency

public IlcGranularFunction getEfficiency() const

This member function returns the efficiency function attached to the invoking calendar, if such a function exists.

getImpl

public IlcCalendarI * getImpl() const

This constructor creates an object by copying another one. This constructor creates an object by copying another one. This member function returns a pointer to the implementation object of the invoking handle.

getName

public const char * getName() const

This member function returns the name of the invoking object.

getObject

public IlcAny getObject() const

This member function returns a pointer to the external object associated with the invoking object, if there is such an association. It returns 0 (zero) otherwise.

getSchedule

public IlcSchedule getSchedule() const

This member function returns the schedule, an instance of IlcSchedule, to which the invoking calendar belongs.

getSolver

public IloSolver getSolver() const

This member function returns an instance of IloSolver associated with the invoking object.

getSolverI

public IloSolverI * getSolverI() const

This member function returns a pointer to the implementation object of the solver where the invoking object was extracted.

operator=

public void operator=(const IlcCalendar & h)

This operator assigns an address to the handle pointer of the invoking object. That address is the location of the implementation object of the provided argument.

removeShiftObject

public void removeShiftObject(IlcShiftObject shiftObj)

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

setBreakList

public void setBreakList(IlcIntervalList list)

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

setEfficiency

public void setEfficiency(IlcGranularFunction f)

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

setName

public void setName(const char * name) const

This member function sets the name of the invoking object to a copy of name. This assignment is a reversible action.

setObject

public void setObject(IlcAny object) const

This member function establishes a link between the invoking object and an external object of which the invoking object might be a data member.