If true, the distance table calculation of the Dima is in progress.

Currently performed distance table calculation action.

Progress value [per mille] of the currently performed distance table calculation.

If true, the user has aborted the progress.

If true, the specified countries are used exclusively. Ohterwise the specified countries are banned in route calculation.

The list of country codes to use exclusively or ban in route calculation.

The coordinate format of the Dima's locations.

All locations must have the specified coordinate format to access the Dima.

The maximum number of locations which may be contained in the distance table.

The default value is 18918, but this value can be much greater and depends on the available memory. As a rule of thumb the greatest value equals sqrt(memory in bytes / 6).

If the maximum number of locations is exceeded by extending the Dima, the location which has not been used for the longest amount of time for extensions will be removed from the Dima for each supernumerary new location.

The type of linking the locations to the road network.

Decides if the distance table is calculated via single (1:1) or multi routings (1:n).

Specified as a string of 16 comma separated values.

These 8 pairs of speeds [in kilometers per hour] represent a speed range (fastest, slowest) for each network road class.

The network road classes are specified as follows:

1. motorway

2. highway

3. trunk roads

4. country roads

5. city streets

6. residential streets

7. drivable but normally blocked roads

8. cycle lanes and walkways

Weights the routing calculation between distance and time, whereby 0 calculates the shortest and 100 calculates the fastest route.

Malus for highways in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each highway segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each highway segment will be increased by the denoted percentage value
• >2500: Highways are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for side roads in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each side road segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each side road segment will be increased by the denoted percentage value
• >2500: Side roads are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for ferries in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each ferry segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each ferry segment will be increased by the denoted percentage value
• >2500: Ferries are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for urban areas in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each urban area segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each urban area segment will be increased by the denoted percentage value
• >2500: Urban areas are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for residents only roads in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each residents only road segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each residents only road segment will be increased by the denoted percentage value
• >2500: Residents only roads are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for ramps in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each ramp segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each ramp segment will be increased by the denoted percentage value
• >2500: Ramps are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for toll roads in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each toll road segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each toll road segment will be increased by the denoted percentage value
• >2500: Toll roads are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

Malus for vignette roads in route calculation.

The malus has to be described by a value which will be interpreted as a percentage value.

• 0: No effect on the objective function
• <0: The resulting cost-value for each vignette road segment will be decreased by the denoted percentage value
• >0: The resulting cost-value for each vignette road segment will be increased by the denoted percentage value
• >2500: Vignette roads are banned

The default value might not be 0, so omit this value in order to leave it unchanged.

The list of countries to use exclusively or ban in route calculation

Reference time for time-dependent feature layers. Each route in the distance matrix contains this time as start time.

The unique key to identify the Dima.

The parameter for route calculation and administration of the Dima.

Distance [in meter] between two locations.

Driving period [in seconds] between two locations.

The X coordinate of the location.

The Y coordinate of the location.

Start-location of the relation.

Destination-location of the relation.

Start-location and destination-location.

Distance and driving period between the start-location and the destination-location.

Status of a DistPeriod object.

Possible values are:

• OK: Distance and driving period for the associated relation is calculated.
• WAYNOTFOUND: The route between the locations of the associated relation could not been found.
• WAYNOTCALCULATED: Distance and driving period for the associated relation is not calculated yet.
• INVALIDSTARTLOCATION: The Dima doesn't contain the start-location of the relation.
• INVALIDDESTINATIONLOCATION: The Dima doesn't contain the destination-location of the relation.

Linking locations to the road network.

Route calculations.

Mercator.

Geodecimal (WGS84).

Example: 8° 15' 30" corresponds to 825833

Super conform.

Degrees, minutes and seconds (WGS84).

Example: 8° 15' 30" corresponds to 815300

Gauss Krueger

UTM.

Conform.

Smart units.

Distances and driving periods from the distance table of the Dima.

Geometric distances (without driving periods).

Distances and driving periods are calculated via reference points, that means the xDima searches the nearest neighbor location in the distance table of the Dima for each denoted location and calculates approximated distances.

Distance and driving period for the associated relation is calculated.

The route between the locations of the associated relation could not been found.

Distance and driving period for the associated relation is not calculated yet.

The Dima does not contain the start-location of the relation.

The Dima does not contain the destination-location of the relation.

License is not valid or has expired.

Invalid profile settings.

General error code of the xdima module.

General error code of the xdima's calculation and administration engine.

A required input parameter is missing.

Invalid input parameter.

Binary files in little endian byte order..

Binary files in little endian byte order.

Text files in ASCII format.

The location has to be linked to the geographically nearest valid segment.

The location has to be linked to the geographically nearest valid node.

The location has to be linked to the geographically nearest valid main node

The distance table is calculated via multi (1:n) routings.

The distance table is calculated via single (1:1) routings.

Car.

Truck.

The left top corner point.

The right bottom corner point.

Specifies how many requests have still to be calculated.

The number of successful calculations so far.

The number of failed computations so far.

The current action being executed. For more information on progress see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "Optimization.".

The unique key to identify the distance matrix currently being calculated.

The 1-based index of the distance matrix currently being calculated. Depending on the number of different vehicles in the request the number of distance matrices to be calculated can be greater than

The index of the last distance matrix to be calculated, that is the total number of distance matrices.

The progress of the distance matrix currently being processed, available only if action equals "DistanceMatrix.Calculation".

The 1-based index of the current row of the current distance matrix being calculated.

The index of the last row of the current distance matrix to be calculated.

If not null, this attribute contains the well-known binary encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the well-known text encoded form of the geometry

If not null, this attribute contains the explicit form of the geometry

The available machine time stated in the request in [s]. This value is 0 if available machine time is not set in the request.

The machine time already used in [s].

The index of this iteration. Index 0 denotes the initial plan directly after construction or the input plan.

The number of improvements the algorithm has already achieved. In other words, this is the number of tour plans with a smaller value of costOfObjectiveFunction than the best one at that time.

The key figures characterizing the current tour plan.

The key figures characterizing the currently best tour plan.

The key figures characterizing the initial tour plan. The initial tour plan is the input plan, if available, or the first tour plan after the construction step.

This id references the background job on the server.

The current status of the job.

The current progress of the job. Can be null at the very beginning or very end of the request execution.

Elapsed time since this job has been queued.

The KML string itself.

The placemarks of the KML. If empty, all placemarks will be used. This will result in a GeometryCollection, if more than one exists.

The optimization aims at minimizing the objective function. This value contains its arithmetical cost.

The significance of this value is not the value itself, but rather if and how fast it decreases during the calculation. The faster the value decreases the better the tour plans become according to the GoalImportance which defines what "better" means, at all.

The number of orders already being scheduled.

The number of orders not being scheduled, yet. These orders are feasible and can be scheduled during further improvement iterations.

The number of orders not being scheduled. These orders are infeasible and will not be scheduled during further improvement iterations.

The number of vehicles being scheduled.

The number of all planned tours.

The sum of the tour periods for all planned tours ([sec]).

The sum of the tour driving periods for all planned tours ([sec]).

The sum of the tour waiting periods for all planned tours ([sec]).

The sum of the tour distances for all planned tours ([m]).

The sum of the tour costs for all planned tours ([MU]). The costs per chain will not be included, see attribute totalChainCosts.

The sum of the costs per chain of all planned chains ([MU]). See VehicleCosts.

The sum of the chain periods of all planned chains ([sec]). The chain period is defined as the period between the start of the first tour and the end of the last tour. This period is greater than the sum of the periods of all tours if two subsequent tours do not start right after the other.

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The index of the current loop being calculated.

The index of the last loop being calculated. The calculation will automatically be finished by the algorithm before reaching this index when no improvement could be reached, anymore. The total number of loops can be set for the improvement step, only (see Params).

The progress in % of the current loop being calculated.

The set of geometries making up the geometry collection.

The set of points defining the line string.

The set of points defining the linear ring.

The set of line strings making up the multi line string.

The set of points making up the multi point.

The set of polygons making up the multi polygon.

The x coordinate

The y coordinate

The z coordinate (optional, only if requested)

The set of linear rings making up the polygon.

The current action being executed. For more information on progress information see About Asynchronous Protocol.

The progress of the distance matrix calculation, available only if action starts with "DistanceMatrix.".

The progress of the improvement step during the tour plan optimization, available only if action equals "Optimization.Improvement".

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

If not null, this attribute contains the explicit form of the geometry.

ATTENTION: Filled with requested EncodedGeometry representation (not necessarily a plain geometry).

The coordinate format used in the request/response.

The geometry encoding for the response.

The name of the parameter profile to be used.

For internal use only.

If the coordFormat equals to 'OG_SRID', this attribute contains the Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC), otherwise it is null. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG.

The current action being executed. For more information on progress with territory planning see the use case documentation.

The progress of the distance matrix calculation, available only if action equals "DistanceMatrix.Calculation".

The progress of the optimization, available only if action starts with "TerritoryOptimization.".

If defined this optional parameter enables additional progress updates with the specified interval. If no new progress update arrives during the specified period, watchJob will wait for and return with the next available progress update. Important updates such as terminal states will always return immediately. The minimum period must be at least 250ms. If no progress waiting period is defined, progress will only be sent as part of status updates.

Specifies the timeout after which watchJob will report the last status even if no further updates are available.If not specified a configured default is used.

The current action being executed.

The progress of the optimization, available only if action starts with "LoadingSpaceOptimization.".

OpenGIS representation of WGS 84 coordinates. Example x=8.2505556, y=48.7627778.

PTV representation of coordinates by degree, minute, and second. Example x=815020, y=4845460.

PTV representation of WGS 84 coordinates. Example x=825056, y=4876278.

PTV representation of conform coordinates. Example x=1672358, y=1620743.

PTV representation of super-conform coordinates. Example x=5072358, y=3320743.

PTV internal coordinate format. Example x=4352286, y=5456405.

This format is set implicitly, if a Spatial Reference Identifier as specified by the Open Geospatial Consortium (OGC) is set in the CallerContext. All codes of the EPSG Geodetic Parameter Dataset V7.9 maintained by the EPSG..
Note: The coordinate format 'OG_GEODECIMAL' and the SRID code 'EPSG:4326' are equivalent.

The specified WKT in the request is invalid. It should a well-known text representation of a geometry from a string (see the OpenGIS simple features specification).

The specified WKB in the request is invalid. It should be a geometry from a byte stream in well-known binary format.

The specified KML in the request is invalid.

Thrown, if requested placemark name is not found in the KML

One or more geometry objects in the request are invalid. There are problems to convert a geometry object to a plain geometry object. Also used for retrieving the plain geometry object from a geometry object.

There are problems to convert a CoordFormat of the request to a coordinate type.

Geometry objects cannot be encoded.

Plain geometry encoding using structured objects and according network presentation.

Geometry should be represented by well-known binaries.

Use well-known texts to encode geometry objects.

Use Keyhole Markup Language to encode geometry objects.

Job has been enqueued.

Job is currently running.

Stop has been requested, the job will terminate its calculation as soon as possible.

Job has completed successfully.

Job has failed with an exception.

The job was deleted by the user.

The job is in an unknown state. For example a given id is unknown or the job has already been fetched and has thus been deleted from the underlying persistent store.