NDD ModelModel

Overview

The model is the top-level object which contains all the defined input data for an NDD solve. It brings together the dimension configuration, locations, jobs (with profiles), vehicles (with multi-day shifts), vehicle classes, cost classes, transit rules, transit generators, and optional predefined task sequences.

Applicable models

• NDD ndd-cmibu6krtqja

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;
}

Fields

dimensions

The dimension configuration defining the measurement dimensions, units, and planning horizon (week length and period length).

locations

A list of locations defining the physical positions at which tasks are performed.

jobs

A list of jobs defining the work to be scheduled. Each job carries a profile specifying its visit frequency and day-pattern constraints.

vehicles

A list of vehicles defining the available resources. Each vehicle specifies a vector of shifts covering the days in the planning period.

vehicleClasses

A list of vehicle classes defining how groups of vehicles interact with dimensions and transit data.

vehicleCostClasses

A list of vehicle cost classes defining the cost structures for groups of vehicles.

transitRules

A list of transit rules defining conditional activities triggered during transit (e.g. rest breaks).

transitGenerators

A list of transit generators linking vehicle classes to distance and time matrices.

taskSequence

An optional list of task sequences providing predefined routes. Used in conjunction with Evaluate or ReOptimise solve requests.

Notes

• All identifiers referenced across the model (e.g. locationId on tasks, classId on vehicles) must correspond to objects defined in the model. Unresolved references will result in an error.
• The weekLength and periodLength in the dimension configuration must be consistent with the profiles on jobs and the number of shifts on vehicles.