TerrainRouteOperator.OutputRouteDetails Property
Gets or sets a boolean that says whether more detailed route features shall be output.
Syntax
public System.Boolean OutputRouteDetails { get; set; }Property Value
Default: false
Whether more detailed route features shall be output.
Remarks
If this property is True, the operator will generate not only the ordinary subroute features between the waypoints, but also a more detailed representation of the subroutes. The detailed representation of each subroute will consist of one or more parts, such that each part goes either in terrain or along a single road feature. In other words, the combined geometry of these leg parts will coincide with the ordinary subroute feature, but the leg parts will have a different set of attributes. These attributes may be displayed as labels or used to control the line visualization: for example, a part that goes through a tunnel could be displayed in a different way.
It would usually be best to use a line visualizer either for the whole leg or just for the parts. The leg parts will always have an attribute legPartType, so your line visualizer can use a condition that checks whether the value of this attribute is null.
Remember that the operator can fail to find a subroute for a certain leg, and will then output a placeholder subroute feature that is just a point halfway on the leg. In this case, no leg part features will be generated. Nor will there be any leg part features if the operator succeeds trivially by finding a zero-length subroute between two waypoints that coincide.
Attribute name | Type | Description |
|---|---|---|
legPartType | Atom | One of the atoms terrain, roadWithTerrainAccess, roadWithoutTerrainAccess, bridge, tunnel and ferryRoute. Apart from terrain, these values are analogous to the possible enumeration values of RoadType. Note that if these atom constants are used in an Expression, they should be prefixed by a hash character, for example legPartType != #terrain. |
legPartRoadClass | Int | This attribute will be undefined (null) for a leg part in terrain. Otherwise, the leg part will follow a single road feature and the attribute will get the value of the RoadClass for that road. |
legPartOneWay | Bool | This attribute will be True for a leg part that follows a one-way road. Otherwise, the attribute will be undefined (null). |
legPartSpeed | Double | This attribute will be undefined (null) for a leg part in terrain, since the terrain speed is not constant. Otherwise, it will contain the road speed in km/h, based on the VehicleType and on the RoadClass and SnowDepth for the road. |
legPartSnowDepth | Double | The snow depth, in meters, that the operator assumes for this leg part, based on SnowDepth. |
legPartStartTimeSeconds | Int | The accumulated travel time, in seconds, from the first waypoint to the start of this leg part. Will be generated only if a subroute was found for each previous leg, and if RouteZMeaning = TravelTime. |
legPartStartTimeString | String | A string representing legPartStartTimeSeconds, formatted as hours/minutes/seconds, for example "7M 05S" or "2H 07M 05S". |
legPartEndTimeSeconds | Int | The accumulated travel time, in seconds, from the first waypoint to the end of this leg part. Will be generated only if a subroute was found for each previous leg, and if RouteZMeaning = TravelTime. |
legPartEndTimeString | String | A string representing legPartEndTimeSeconds, formatted as hours/minutes/seconds as above. |
legIndex | Int | The index of the whole leg of which this feature represents a part. |
legPartIndex | Int | The index of this leg part. The leg part numbering restarts from zero for each leg. |
In addition to the special attributes above, each leg part will get copies of the attributes of the current feature from WaypointsInput, and a leg part that follows a road will also get copies of the road feature attributes.
 |
In the example screenshot, the leg parts on roads are solid black while those in terrain are dotted green; the line visualizer checks whether legPartType is #terrain. The small time labels that show intermediate travel times come from the legPartStartTimeString. Leg parts along a named road also display the road name, and leg parts along a tollway are decorated with dollar signs; these visualizers use attributes that were copied from the original road features. (The many time labels along Schöttlstrasse and Risser Strasse occur because these roads are represented by many road features, with some subtle differences in attributes.)
In order to display a label for legPartStartTimeString at the start of each leg part, as is done in the screenshot, use a TextVisualizer with at = 0 and repeat = Node. To instead display a label for legPartEndTimeString at the end of each leg part, use a text visualizer with at = −1 and repeat = Node. You would of course want to display at most one of these two attributes, since the end time of one leg part is the start time of the next, but it may sometimes be useful that both attributes are available. If you prefer to design your own time format for these labels, see the section "Formatting travel times" in the main class documentation.
Platforms
Windows, Linux, Android