5.7 Location Object
Each location in the scenario is represented by a location object. It has the following fields:
- Field: id
Required: Yes.
Type: String.
Description: a unique identifier for the location. - Field: name
Required: No.
Type: String.
Description: The name (e.g. a store or site name) for the location. - Field: tags
Required: No.
Type: Array of strings.
Description: Client-specific information associated with the location. This field is ignored by the optimiser. - Field: attributes
Required: No.
Type: Array of strings.
Description: An array containing the names of any attributes the location has. - Field: address
Required: No.
Type: String.
Description: The street address of the location. - Field: longitude
Required: Yes.
Type: Number.
Description: The longitude of the location in decimal degrees. Must be in [-180, 180]. - Field: latitude
Required: Yes.
Type: Number.
Description: The latitude of the location in decimal degrees. Must be in [-90, 90]. -
Field: site_time
Required: No.
Type: String (HH:MM).
Default: 00:00.
Description: Site time for the location. (See Site Time in Section x14-240002.102.10.)9.Field: opening_time
Required: No.
Type: String (HH:MM).
Default: 00:00.
Description: The opening time of a location. (See Opening Time in Section x14-240002.102.10.)10.Field: closing_time
Required: No.
Type: String (HH:MM).
Default: null (meaning no closing time).
Description: The closing time of a location. (See Closing Time in Section x14-240002.102.10.) - Field: time_windows
Required: No.
Type: Array of time window objects.
Default: Empty array (i.e. the location is always open).
Description: An array containing the location’s opening hours as time window objects. -
Field: load_time
Required: No.
Type: String (HH:MM).
Default: 00:00.
Description: Load time for a location. (See Load Time in Section x14-240002.102.10.)13.Field: unload_time
Required: No.
Type: String (HH:MM).
Default: 00:00.
Description: Unload time for a location. (See Unload Time in Section x14-240002.102.10.)14.Field: cost_per_visit
Required: No.
Type: Number.
Default: 0.
Description: The cost incurred when a vehicle visits this location. This may be negative to represent gains associated with visiting the location. (See Cost per Visit in Section x14-240002.102.10.) - Field: hidden_cost_per_visit
Required: No.
Type: Number.
Default: 0.
Description: An additional cost incurred when a vehicle visits this location. This may be negative and is not included in the cost calculation for the solution. (See Hidden Cost per Visit in Section x14-240002.102.10.) - Field: loading_bays
Required: No.
Type: Number (nonnegative integer).
Description: The number of loading bays at this location. - Field: loading_bay_gap
Required: No.
Type: String (HH:MM).
Default: 00:00.
Description: The loading bay gap at this location. - Field: allow_preloading
Required: No.
Type: Boolean.
Description: If set to TRUE, then vehicles can preload at this location.
Note: See Preloading for more information. - Field: allow_order_splitting
Required: No.
Type: Boolean.
Description: If set to TRUE, then orders that are picked up or delivered to this location can be split according to the order splitting strategy.
Note: The order must also allow splitting for this to take effect.

