4.4 Vehicle Object

The vehicle is described by an object with the following fields:

  1. tags: an array of strings, giving client-specific information about the vehicle. This field is not used by the optimiser. It may be null or empty.
  2. bookend_minimum_fill_percentage: a number, between 0 and 1.0 (inclusive), that specifies the percentage of the safe fill level of a bookend compartment that is the minimum to which the compartment must be filled to satisfy the stability constraints. The default is 1 (i.e. 100%).
  3. disable_large_compartment_ullage_restrictions: a Boolean, if true then ullage restrictions for large compartments will not be applied. The default is false (i.e. ullage restrictions will be applied).
  4. axle_groups: a non-empty array of axle group objects.
  5. gcm_limits: a non-empty array of axle limit objects.
  6. compartments: a non-empty array of compartment objects.