5.2 General Object

The general object contains settings for optimiser Global Parameters (see Section  2.8). It has the following fields:

1. Field: name
   Required: No.
   Type: String.
   Description: A name for the scenario.
2. Field: iterations
   Required: No.
   Type: Number.
   Default: 3000.
   Description: The number of iterations that the optimiser should run for.
3. Field: iteration_scheme
   Required: No.
   Type: String.
   Default: null.
   Description: The identifier of the iteration scheme to be used by the optimiser.
   Note: If an iteration scheme is specified, this it will override the values of the iterations and maximum_neighbourhood_size fields if they are also present.
4. Field: maximum_neighbourhood_size
   Required: No.
   Type: Number.
   Default: 200.
   Description: The maximum size of a neighbourhood for the optimiser. (See Maximum Neighbourhood Size in Section  2.8.)
5. Field: geofence_north
   Required: No.
   Type: Number in [-90, 90].
   Description: The latitude of the northern boundary for locations in scenario. Acts to enforce accuracy of geocodes.
6. Field: geofence_east
   Required: No.
   Type: Number in [-180, 180].
   Description: The longitude of the eastern boundary for locations in scenario. Acts to enforce accuracy of geocodes.
7. Field: geofence_south
   Required: No.
   Type: Number in [-90, 90].
   Description: The latitude of the southern boundary for locations in scenario. Acts to enforce accuracy of geocodes.
8. Field: geofence_west
   Required: No.
   Type: Number in [-180, 180].
   Description: The longitude of the western boundary for locations in scenario. Acts to enforce accuracy of geocodes.
9. Field: hard_geofence_errors
   Required: No.
   Type: Boolean.
   Default: false.
   Description: If true, then treat any errors produced by geofence violations as being hard.
10. Field: colocated_pickups
    Required: No.
    Type: Boolean.
    Default: false.
    Description: If true, then enforce the colocated pickups constraint.
11. Field: batched_loads
    Required: No.
    Type: Boolean.
    Default: true.
    Description: If true, then enforce the batched loads constraint.
12. Field: use_miles
    Required: No.
    Type: Boolean.
    Default: false.
    Description: If true, then distance values in the solution will be in miles rather than kilometres.
13. Field: preferred_vehicle_fixed_reward
    Required: No.
    Type: Number (positive).
    Default: 0.
    Description: If replanning, a fixed reward for assigning an order to its originally planned vehicle.
14. Field: preferred_vehicle_weight_reward
    Required: No.
    Type: Number (positive).
    Default: 0.
    Description: If replanning, a weight scaled reward for assigning an order to its originally planned vehicle.
15. Field: preferred_vehicle_volume_reward
    Required: No.
    Type: Number (positive).
    Default: 0.
    Description: If replanning, a volume scaled reward for assigning an order to its originally planned vehicle.
16. Field: sticky_deliveries
    Required: No.
    Type: Boolean.
    Default: false.
    Description: If true, then enforce the Sticky Deliveries constraint.
17. Field: cost_scale
    Required: No.
    Type: Number.
    Default: 0 (Which means to not apply cost scaling.)
    Description: Scale costs by this amount before solving. (See Scaling Factors in Section  2.8).
18. Field: weight_scale
    Required: No.
    Type: Number.
    Default: 0 (Which means to not apply weight scaling.)
    Description: Scale weights by this amount before solving. (See Scaling Factors in Section  2.8).
19. Field: volume_scale
    Required: No.
    Type: Number.
    Default: 0 (Which means to not apply volume scaling.)
    Description: Scale volumes by this amount before solving. (See Scaling Factors in Section  2.8).
20. Field: arrival_only_in_tw
    Required: No.
    Type: Boolean.
    Default: false.
    Description: Enables the Arrival Only in Time Window behaviour.