public class PathGuideItem
extends java.lang.Object
implements java.io.Serializable
The path guide sub item class.
It records how to drive step by step from starting point to end, where each step represents a sub item, including the points and arcs passed during the process. These points can be the selected points when analyzing, also can be the network nodes passed by the analysis result; the arcs can be the edges of network or a part of a network edge . The sub items of path guide object can be set through the class. Such as: returning the sub item ID, name, number, weight, etc., determining whether a sub item is point or arc, etc.
Modifier and Type | Field and Description |
---|---|
Rectangle2D |
bounds
The range of PathGuide.
|
java.lang.String |
description
The description for PathGuide.
|
DirectionType |
directionType
The direction of path.
|
double |
distance
The distance from the site to the arc.
|
Geometry |
geometry
The object on ground corresponding with the path guide item.
|
int |
id
The ID of PathGuideItem object If the item is an arc, this value is the ID of the corresponding arc; If the item is a network node, this value is the ID of the corresponding node; If the item is the site which does not on the network, this value is -1.
|
int |
index
The No.
|
boolean |
isEdge
Determines whether the item is an arc.
|
boolean |
isStop
Determines whether the item is an site, that is the point inputed by users for path analysis, Sites may overlap with network nodes, or they may not be on the network.
|
double |
length
The length of arc (when the item is a arc).
|
java.lang.String |
name
The name of PathGuideItem object
|
SideType |
sideType
Driving position is on the left side of the road, on the right side or on the road.
|
double |
turnAngle
Angle of turning.
|
TurnType |
turnType
Direction of turning.
|
double |
weight
The weight value of item, that is the cost of item.
|
Constructor and Description |
---|
PathGuideItem()
The Constructor.
|
PathGuideItem(PathGuideItem pathGuideItem)
Copy constructor.
|
public java.lang.String description
The description for PathGuide.
public Geometry geometry
The object on ground corresponding with the path guide item.
public Rectangle2D bounds
The range of PathGuide. For arcs, it is the external rectangle of the arc. For point, it is the point self.
public DirectionType directionType
The direction of path.
There are 5 values returned: East, South, West, North and none direction. When the value returned by isEdge method is True, the directionType can be East, South, West, North; When the value returned by isEdge method is False, the directionType is none direction.
public double distance
The distance from the site to the arc.
The distance is the distance from the site to the nearest arc. As follows, orange points represent the network nodes, blue represents arcs, the gray points indicate the sites, the red lines mean the distance. For example, if the users want to calculate the shortest path from home to hospital riding bus, except the shortest path needs to be calculated, the shortest path from home to the bus station also should be calculated and this path is the distance identified by distance
.
public int id
The ID of PathGuideItem object If the item is an arc, this value is the ID of the corresponding arc; If the item is a network node, this value is the ID of the corresponding node; If the item is the site which does not on the network, this value is -1. The analyzed shortest path from site 1 to site 2 is shown as follows, the position of site 1 is as a path guide sub item, the ID value is -1, the next path guide sub item is the arc 1, its ID is the arc's ID; and the next item is the network node A, its ID is the ID of node A.
public int index
The No. of PathGuideItem object.
public double length
The length of arc (when the item is a arc).
public java.lang.String name
The name of PathGuideItem object
public SideType sideType
Driving position is on the left side of the road, on the right side or on the road.
When isEdge
is true, returning SideType.NONE
.
public double turnAngle
Angle of turning. The unit is degree, accurate to 0.1 degrees.
public TurnType turnType
public double weight
The weight value of item, that is the cost of item.
public boolean isEdge
Determines whether the item is an arc.
True means the item is an arc, false means the item isn't an arc.
public boolean isStop
Determines whether the item is an site, that is the point inputed by users for path analysis, Sites may overlap with network nodes, or they may not be on the network.
As the above figure, the site 1,2 are not on the network. True means it is a point, false means it isn't a point.
public PathGuideItem(PathGuideItem pathGuideItem)
Copy constructor.
pathGuideItem
- the object of path guide item.public PathGuideItem()
The Constructor.
public int hashCode()
Gets the hash code value of path guide item.
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
Determines whether the specified object is equal to the current PathGuideItem object.
equals
in class java.lang.Object
obj
- the object to compare with the current PathGuideItem object.