com.supermap.web.iServerJava6R.networkAnalystServices
public class PathGuideItem
继承 PathGuideItem Inheritance Object

行驶导引子项类.

行驶导引由多个行驶导引子项构成,记录了如何一步步从起点行驶到终点,其中每一步就是一个行驶导引子项。每个分析结果路径中均包含该路径的行驶引导,每个行驶引导子项可以表示一个弧段,一个结点或一个站点,记录了在当前地点转弯情况、行驶方向、耗费等信息。



公共属性
  属性 定义方
    bounds : Rectangle2D
行驶导引子项所代表的对象(弧段或结点或站点)的范围.
PathGuideItem
    description : String
[read-only] 行驶导引子项的描述信息,如在最佳路径分析中,描述某一站点时该属性值为:“从此处出发”,表示该站点为起始点。
PathGuideItem
    directionType : String
行驶的方向.
PathGuideItem
    distance : Number
站点到弧段的距离.
PathGuideItem
    geometry : Geometry
当前行驶导引子项的几何信息。
PathGuideItem
    id : int
行驶导引子项的 ID 号,即 edgeID 或 nodeID.
PathGuideItem
    index : int
行驶导引子项的序号.
PathGuideItem
    isEdge : Boolean
判断本行驶导引子项是否是弧段。true 表示行驶导引子项是弧段,false 表示行驶导引子项不是弧段。
PathGuideItem
    isStop : Boolean
该子项是否为站点.
PathGuideItem
    length : Number
当行驶导引子项为弧段时表示弧段的长度。
PathGuideItem
    name : String
行驶导引子项的名称。
PathGuideItem
    sideType : String
站点是在路的左侧、右侧还是在路上的常量,由 SideType 为定义.
PathGuideItem
    turnAngle : Number
转弯角度。单位为度,精确到0.1度。
PathGuideItem
    turnType : String
转弯方向常量。当该类的字段 isEdge 为 true 时将返回 TurnType.None,表示无效值。
PathGuideItem
    weight : Number
行驶导引子项的权值,即行使导引对象子项的耗费。
PathGuideItem
属性详细信息
bounds 属性
bounds:Rectangle2D

行驶导引子项所代表的对象(弧段或结点或站点)的范围.

对弧段而言,为弧段的外接矩形;对点而言,为点本身。


Implementation
    public function get bounds():Rectangle2D
    public function set bounds(value:Rectangle2D):void
description 属性  
description:String  [read-only]

行驶导引子项的描述信息,如在最佳路径分析中,描述某一站点时该属性值为:“从此处出发”,表示该站点为起始点。


Implementation
    public function get description():String
directionType 属性  
directionType:String

行驶的方向.

共有五个方向,即东、南、西、北、无方向。当该类中字段 isEdge 为 false 时,即为结点,则行驶方向的类型为无方向。


Implementation
    public function get directionType():String
    public function set directionType(value:String):void
distance 属性  
distance:Number

站点到弧段的距离.

该距离是指站点到最近一条弧段的距离。
如下图所示,桔色点代表网络结点,蓝色代表弧段,灰色点为站点,红色线段代表距离。比如用户希望计算出从家里出发乘坐公交车去医院的最短路程,除了计算出公交线路的最短路程外,还需要计算出从家走到公交站的最短距离,这个距离就是该属性的值表示。


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
geometry 属性  
geometry:Geometry

当前行驶导引子项的几何信息。


Implementation
    public function get geometry():Geometry
    public function set geometry(value:Geometry):void
id 属性  
id:int

行驶导引子项的 ID 号,即 edgeID 或 nodeID.

行驶导引对象子项的 ID。子项为弧段时,此值为相应弧段的ID号;子项为网络结点时,此值为相应结点的ID号;
子项为不在网络上的站点时,此值为-1。下图所示为分析得到的站点1到站点2之间的最短路径,


Implementation
    public function get id():int
    public function set id(value:int):void
index 属性  
index:int

行驶导引子项的序号.

当行驶导引对象子项为弧段时,其 index 的值为-1。


Implementation
    public function get index():int
    public function set index(value:int):void
isEdge 属性  
isEdge:Boolean

判断本行驶导引子项是否是弧段。true 表示行驶导引子项是弧段,false 表示行驶导引子项不是弧段。


Implementation
    public function get isEdge():Boolean
    public function set isEdge(value:Boolean):void
isStop 属性  
isStop:Boolean

该子项是否为站点.

站点为用户指定的用于做路径分析的点,站点可能与网络结点重合,也可能不在网络上。true 表示是站点,false 表示不是站点。


Implementation
    public function get isStop():Boolean
    public function set isStop(value:Boolean):void
length 属性  
length:Number

当行驶导引子项为弧段时表示弧段的长度。


Implementation
    public function get length():Number
    public function set length(value:Number):void
name 属性  
name:String

行驶导引子项的名称。


Implementation
    public function get name():String
    public function set name(value:String):void
sideType 属性  
sideType:String

站点是在路的左侧、右侧还是在路上的常量,由 SideType 为定义.

当该类的字段 isEdge 为 true 时将返回 SideType.None,表示无效值。


Implementation
    public function get sideType():String
    public function set sideType(value:String):void

另请参见

turnAngle 属性  
turnAngle:Number

转弯角度。单位为度,精确到0.1度。


Implementation
    public function get turnAngle():Number
    public function set turnAngle(value:Number):void
turnType 属性  
turnType:String

转弯方向常量。当该类的字段 isEdge 为 true 时将返回 TurnType.None,表示无效值。


Implementation
    public function get turnType():String
    public function set turnType(value:String):void

另请参见

weight 属性  
weight:Number

行驶导引子项的权值,即行使导引对象子项的耗费。


Implementation
    public function get weight():Number
    public function set weight(value:Number):void