Import and Update Distance Matrix
It is possible to import distance matrix with user-defined contents. Then, this distance matrix can be extended using the update operation.
Benefits
- Customer can import its own data into a matrix and use it in other services.
- Import and update operations can be combined to import very big matrix.
Prerequisites
Please ensure following prerequisites are fulfilled before you start with the use case:
- Installed and licensed PTV xDima service
Concepts
Programming Guide
The following example shows how to import a 1x2 distance matrix and retrieve the 2 values.
The content of the distance matrix is imported using the createDistanceMatrix operation with the ImportDistanceMatrixRequest request.
In this example, the distances and travelTimes are sent with the plain format.
const startLocations = [{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.1037323682103315,
"y": 49.60588624310334
}
}];
const destinationLocations = [{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.172880691010506,
"y": 49.60588624310334
}
},{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.1529654781157905,
"y": 49.61112799252659
}
}];
const createRequest = {
"$type": "ImportDistanceMatrixRequest",
"startLocations": startLocations,
"destinationLocations": destinationLocations,
"contents": {
"$type": "DistanceMatrixContentsArrays",
"distances": [7500, 7900],
"travelTimes": [900, 1020]
}
};
xdima.createDistanceMatrix(createRequest, createDimaCallback);
function createDimaCallback(response, exception) {
var request = {
"$type": "GetDistanceMatrixByLocationsRequest",
"id": response.summary.id,
"resultFields": {
"distanceMatrixContentsResultFields": {
"distances": true,
"travelTimes": true
}
},
"startLocations": startLocations,
"destinationLocations": destinationLocations
};
xdima.getDistanceMatrix(request, function(result, exception) {
getDistanceMatrixCallback(result, response.summary.id, exception);
});
}
function getDistanceMatrixCallback(response, id, exception) {
print(" The matrix has been imported and the stored values are: {"+
response.contents.distances[0] + "m/" + response.contents.travelTimes[0] + "s}, {"+
response.contents.distances[1] + "m/" + response.contents.travelTimes[1] + "s}");
var deleteRequest = {
"id": id
};
xdima.deleteDistanceMatrix(deleteRequest);
}
The following example shows how to import a 1x2 distance matrix. Then extend the matrix with a 3rd destinations. Finally retrieve the 3 values.
A distance matrix is imported using the same process than the previous example.
Then this distance matrix is extended using the UpdateDistanceMatrixRequest operation with the ExtendDistanceMatrixWithContentsRequest request.
In this example, the distances and travelTimes are sent with the plain format.
const startLocations = [{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.1037323682103315,
"y": 49.60588624310334
}
}];
const destinationLocations = [{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.172880691010506,
"y": 49.60588624310334
}
},{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.1529654781157905,
"y": 49.61112799252659
}
}];
const additionalDestinationLocation = [{
"$type": "OffRoadRouteLocation",
"offRoadCoordinate": {
"x": 6.138150,
"y": 49.587211
}
}];
const createRequest = {
"$type": "ImportDistanceMatrixRequest",
"startLocations": startLocations,
"destinationLocations": destinationLocations,
"contents": {
"$type": "DistanceMatrixContentsArrays",
"distances": [7500, 7900],
"travelTimes": [900, 1020]
}
};
xdima.createDistanceMatrix(createRequest, createDimaCallback);
function createDimaCallback(response, exception) {
var request = {
"$type": "ExtendDistanceMatrixWithContentsRequest",
"id": response.summary.id,
"startLocations": startLocations,
"destinationLocations": additionalDestinationLocation,
"contents": {
"$type": "DistanceMatrixContentsArrays",
"distances": [4500],
"travelTimes": [600]
}
};
xdima.updateDistanceMatrix(request, function(result, exception) {
updateDimaCallback(result, response.summary.id, exception);
});
}
function updateDimaCallback(response, exception) {
var request = {
"$type": "GetDistanceMatrixByLocationsRequest",
"id": response.summary.id,
"resultFields": {
"distanceMatrixContentsResultFields": {
"distances": true,
"travelTimes": true
}
},
"startLocations": startLocations,
"destinationLocations": [destinationLocations[0], destinationLocations[1], additionalDestinationLocation[0]]
};
xdima.getDistanceMatrix(request, function(result, exception) {
getDistanceMatrixCallback(result, response.summary.id, exception);
});
}
function getDistanceMatrixCallback(response, id, exception) {
print(" The matrix has been imported and the stored values are: {"+
response.contents.distances[0] + "m/" + response.contents.travelTimes[0] + "s}, {"+
response.contents.distances[1] + "m/" + response.contents.travelTimes[1] + "s}, {"+
response.contents.distances[2] + "m/" + response.contents.travelTimes[2] + "s}");
var deleteRequest = {
"id": id
};
xdima.deleteDistanceMatrix(deleteRequest);
}
Related Topics
The following topics might be relevant for this use case.