About This Manual

Scheduler is a C++ library for modeling scheduling problems. This library is not a new programing language: it lets you use data structures and control structures provided by C++. Thus, the Scheduler part of an application can be completely integrated with the rest of that application (for example, the graphic interface, connections to databases, etc.) because it can share the same objects.

This manual assumes that you are familiar with the operating system in which you are using Scheduler. Since Scheduler is written for C++ developers, this manual assumes that you can write C++ code and that you have a working knowledge of your C++ development environment.

Throughout this manual, the following typographic conventions apply:

• Samples of code are written in this typeface.
• The names of constructors and member functions appear in this typeface in the section where they are documented.
• Important ideas are emphasized like this.

The names of types, classes, and functions defined in the Concert Technology library begin with Ilo.

The names of classes are written as concatenated, capitalized words. For example:

IloActivity

A lower case letter begins the first word in names of arguments, instances, and member functions. Other words in such a name begin with a capital letter. For example,

aVar
IloActivity::getEndVar

There are no public data members in Scheduler, except in goals and demons. (This reference manual and the IBM ILOG Solver Reference Manual document goals and demons.)

Accessors begin with the keyword get followed by the name of the data member. Accessors for Boolean members begin with is followed by the name of the data member. Like other member functions, the first word in such a name begins with a lower case letter, and any other words in the name begin with a capital letter.

Modifiers begin with the keyword set followed by the name of the data member.

class Task  {
public:
  Task(char* name, IloInt duration);
  ~Task();
  IloInt  getDuration() const;
  void setDuration(IloInt duration);
  IloBool isCritical() const;
  void setCritical(IloBool critic);
};

In this reference manual, the documentation of a class uses the caption "Include File" to indicate which header file you need to include in your application. The caption "Definition File" indicates the header file where the class is actually defined.