xls:RoutePlan

The criteria upon which a route is determined.

Element information

Namespace: http://niem.gov/niem/external/ogc-openls/1.1.0/dhs-gmo/1.0.0

Schema document: external/ogc-openls/1.1.0/dhs-gmo/1.0.0/ols.xsd

Type: xls:RoutePlanType

Properties: Global, Qualified

Content

Sequence [1..1]
1. xls:RoutePreference [1..1] Preference to be taken into consideration when determining the route.
2. xls:WayPointList [1..1] List of waypoints along a route.
3. xls:AvoidList [0..1] The list of areas, locations, and types of features in which the route should avoid passing through.

Attributes

Name	Occ	Type	Description	Notes
useRealTimeTraffic	[0..1]	xsd:boolean	Specifies whether to use real time traffic information when determining the best route.	Default value is "false".
expectedStartTime	[0..1]	xsd:dateTime	Specifies the date and time at which travel is expected to begin. Specified in the format YYYY-MM-DD HH:MM. Defaults to current date and time.
expectedEndTime	[0..1]	xsd:dateTime	Specifies the date and time at which travel is expected to end. The format for the end time is specified as Duration

Used in

Type xls:DetermineRouteRequestType (Element xls:DetermineRouteRequest)

Sample instance

<xls:RoutePlan>
   <xls:RoutePreference>Fastest</xls:RoutePreference>
   <xls:WayPointList>
      <xls:StartPoint>
         <xls:Position>...
         </xls:Position>
         <xls:GeocodeMatchCode/>
      </xls:StartPoint>
      <xls:ViaPoint>
         <xls:Position>...
         </xls:Position>
         <xls:GeocodeMatchCode/>
      </xls:ViaPoint>
      <xls:EndPoint>
         <xls:Position>...
         </xls:Position>
         <xls:GeocodeMatchCode/>
      </xls:EndPoint>
   </xls:WayPointList>
   <xls:AvoidList>
      <xls:AOI>
         <gml:CircleByCenterPoint numArc="1">...
         </gml:CircleByCenterPoint>
      </xls:AOI>
      <xls:Position>
         <gml:Point>...
         </gml:Point>
         <xls:Ellipse>...
         </xls:Ellipse>
         <xls:QoP>...
         </xls:QoP>
         <xls:Time begin="2000-01-01T12:00:00"/>
         <xls:Speed value="1.0"/>
         <xls:Direction value="1.0"/>
      </xls:Position>
      <xls:AvoidFeature>Highway</xls:AvoidFeature>
   </xls:AvoidList>
</xls:RoutePlan>