====== ThinkGeo.MapSuite.Routing.RouteSegment ====== {{section>upgrade_map_suite_to_10.0}} This class repesents a routeSegment, which is a base element in routing. ===== Inheritance Hierarchy ===== *System.Object ***ThinkGeo.MapSuite.Routing.RouteSegment** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} RouteSegment() ** * //This is the default constructor for the class.// == Remarks == * //This is the default constructor for the class.// == Parameters ==
** {{wiki:PublicMethod.gif|}} RouteSegment(String,Int32,Single,PointShape,IEnumerable,PointShape,IEnumerable) ** * //This is the constructor for the class.// == Remarks == * //This constructor allows you to provide the information for the routeSegment.// == Parameters == * //featureId// * Type:String * Description:This parameter is the feature ID of the routeSegment. It is an identity of a single routeSegment, thus you cannot set the feature ID to two or more routeSegments. * //routeSegmentType// * Type:Int32 * Description:This parameter specifies the type of routeSegment. You can define a value that represents kind of routeSegment, for example: 0 represents a local routeSegment, 1 represents a major routeSegment, 2 represents a highway. * //weight// * Type:Single * Description:This parameter is the weight of the routeSegment. It can represent, for example, the routeSegment length. * //startPoint// * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] * Description:This parameter is the starting vertex of the routeSegment. * //startPointAdjacentIds// * Type:IEnumerable * Description:This parameter is the adjacent feature IDs of the start point. * //endPoint// * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] * Description:This parameter is the ending vertex of the routeSegment. * //endPointAdjacentIds// * Type:IEnumerable * Description:This parameter is the adjacent feature IDs of the end point.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#ToString.28.29// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Equals.28Object.29// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetHashCode.28.29// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetType.28.29// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} hxQ=() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Finalize.28.29// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#MemberwiseClone.28.29// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} Distance ** N/A == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Distance == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} Weight ** Gets or sets a value representing the weight of the routeSegment. It can represent, for example, the routeSegment length. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Weight == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RouteSegmentType ** Gets or sets a value representing the type of routeSegment. You can define a value that represents kind of routeSegment, for example: 0 represents a local routeSegment, 1 represents a major routeSegment, 2 represents a highway. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#RouteSegmentType == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} StartPoint ** Gets or sets a value representing the starting vertex of the routeSegment. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPoint == Return Value == * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] ** {{wiki:PublicProperty.gif|}} StartPointAdjacentIds ** Gets a value represents the adjacent feature ids of start point. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPointAdjacentIds == Return Value == * Type:Collection ** {{wiki:PublicProperty.gif|}} EndPoint ** Gets or sets a value representing the ending vertex of the routeSegment. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPoint == Return Value == * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] ** {{wiki:PublicProperty.gif|}} EndPointAdjacentIds ** Gets a value representing the adjacent feature IDs of the end point. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPointAdjacentIds == Return Value == * Type:Collection ** {{wiki:PublicProperty.gif|}} FeatureId ** Gets or sets a value representing the feature ID of the routeSegment. It is an identity of a single routeSegment, thus you cannot set the feature ID to two or more routeSegments. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#FeatureId == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} DrivingDirection ** Gets or sets a value representing the next driving direction of the routeSegment. For example, if you are driving on the current routeSegment and will turn right on the next routeSegment, the value will be Right. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#DrivingDirection == Return Value == * Type:[[ThinkGeo.MapSuite.Routing.DrivingDirection|DrivingDirection]] ==== Protected Properties ==== ==== Public Events ====