IVR ModelModel

Overview

The model object pulls all the individually defined pieces together into a single representation which can then be solved. The model encapsulates all the information required by the solver and can be thought of as “an instance of the problem to be solved”.

Applicable models

• IVR7 ivr7-kt461v8eoaif
• IVR8 ivr8-yni1c9k2swof

Model

Schema definition

message Model {
  required DimensionConfiguration dimensions = 1;
  repeated Location locations = 2;
  repeated Job jobs = 3;
  repeated Vehicle vehicles = 4;
  repeated VehicleClass vehicleClasses = 5;
  repeated VehicleCostClass vehicleCostClasses = 6;
  repeated TransitRule transitRules = 7;
  repeated TransitGenerator transitGenerators = 8;
  repeated TaskSequence taskSequence = 9;
  repeated Compartment compartments = 10;           //IVR 8 only
  repeated CompartmentSet compartmentSets = 11;     //IVR 8 only
}

Fields

dimensions

A Dimension Configuration for this model instance.

locations

A list of location objects for this model instance.

jobs

A list of job objects for this model instance.

vehicles

A list of vehicle objects for this model instance.

vehicleClasses

A list of vehicleClass objects for this model instance.

vehicleCostClasses

A list of vehicleCostClass objects for this model instance.

transitRules

A list of transitRule objects for this model instance.

transitGenerators

A list of custom transitGenerator objects for this model instance. (advanced usage)

taskSequence

A list of taskSequence objects for this model instance.

compartments

A list of compartment objects for this model instance.

compartmentSets

A list of compartmentSet objects for this model instance.

Notes

• The general practice is to pluralise sequence arrays. This is, however, not the case with taskSequence.