Hexagon Geospatial
MENU

WebGIS Q&A

WebGIS enables powerful geospatial web applications and services that securely share your organization’s rich geospatial data, and provides tools to deeply examine spatial data and create value added products, on demand.
Showing results for 
Search instead for 
Do you mean 

GeoMedia WebMap Route Service RouteSpec Object.

by Anonymous on ‎02-02-2017 09:30 AM - edited on ‎04-21-2017 06:44 AM by Technical Evangelist (394 Views)

This article describes the GeoMedia WebMap Route Web Service RouteSpec Data Structure. The RouteSpec object is the first parameter passed to the DetermineRoute operation.

 

Route Service RouteSpec Data Structure                                                                             

Property Name

Datatype

Required

Purpose

AvoidLlist

AvoidList

No

The list of locations and types of features which the route should avoid passing through.

DatasetName

String

No

The name of the dataset in which to determine the route. If the property is not specified, the first listed dataset in the result of GetAllDatasetInfo operation will be used.

DistanceUnit

DISTANCEUNITTYPE

No

The unit of distance. The default value is METER.

EdgeRestrictions

Restriction()

No

The edge restrictions to be considered while generating the path result. Edges not satisfying all edge restrictions are blocked.

EndPointFixed

Boolean

No

Indicates that the EndPoint is the last to be visited. The default value is False.

GetBestOrder

Boolean

No

Indicates that the best order route is to be returned. The default value is False.

InstructionSpecification

InstructionSpec

No

Specification of returned instructions.

Language

String

No

The language used in Route Instructions. If the property is not specified, the first listed language in the result of GetAllDatasetInfo operation will be used.

OverrideRestrictions

OverrideRestriction()

No

OverrideRestrictions is a collection of OverrideRestriction objects. This is used to dynamically override the EdgeRestriction values that are read from the binary files on the drive.

ReturnEdgeIDs

Boolean

No

Indicates to return EdgeIDs in the result or not. The default value is False.

ReturnGeometry

Boolean

No

Indicates to return geometry in the result or not.  The default value is False.

ReturnRouteInstructions

Boolean

No

Indicates to return Route Instructions in Route Structure. The default value is true.

ReturnStopGeometry

Boolean

No

Indicates to return Stop Geometry information in the StopSummary of the Route result. The default value is False.

ReturnStopSummary

Boolean

No

Indicates to return Stop Summary information in the Route result. The default value is False.

ReturnToStart

Boolean

No

If true, indicates that the best loop ordering is returned. Otherwise, the best path ordering is returned. The default value is False.

ReturnViolatedRestrictionGeometry

Boolean

No

This property is applicable only when ReturnViolatedRestrictions property is set to True. Geometry for the violated edges is returned if the value is set to True. The default value is False.

ReturnViolatedRestrictions

Boolean

No

Indicates that the edge restrictions are not applied but edges that violate restrictions are indicated in the result. The default value is False.

RoutePreference

String

No

Preference to be considered. If the property is not specified, the first listed RoutePreferenceType in the result of GetAllDatasetInfo operation will be used.

SnapStopsToRestrictedEdges

Boolean

No

Indicates whether stops will be snapped to edges with restrictions set. The default value is True.

StartPointFixed

Boolean

No

Indicates that the StartPoint is the first point to be visited. The default value is False.

StopNames

String()

No

User-defined names for the start point, via point(s), and an end point. When this property is set, the specified names are available in the route instructions to indicate the order in which stops are visited.

The first element of the array represents the name for start Stop, the last element represents the name for end Stop while the elements in between the first and last stops represent the names for the via points. When the ViaPoints property is not set, the array will have only two names to represent start Stop and end Stop names.

UseRealTimeTraffic

Boolean

No

Indicates whether to use real time traffic information. The default value is False.

ViaPoints

PointPropertyType()

No

Intermediate ordered way points along the route between the starting point and the ending point.

Contributors