thinkgeo.mapsuite.routing.routesegment
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.routing.routesegment [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Routing.RouteSegment ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class repesents a routeSegment, which is a base element in routing. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment</a> | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.Routing.RouteSegment]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RouteSegment()|RouteSegment]] | | | This is the default constructor for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RouteSegment(String, Int32, Single, PointShape, IEnumerable<String>, PointShape, IEnumerable<String>)|RouteSegment]] | String, Int32, Single, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<String>, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], IEnumerable<String> | | This is the constructor for the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Distance|Distance]] | Single | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrivingDirection|DrivingDirection]] | [[ThinkGeo.MapSuite.Routing.DrivingDirection|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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#EndPoint|EndPoint]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | Gets or sets a value representing the ending vertex of the routeSegment. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#EndPointAdjacentIds|EndPointAdjacentIds]] | Collection<String> | | Gets a value representing the adjacent feature IDs of the end point. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FeatureId|FeatureId]] | String | | 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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RouteSegmentType|RouteSegmentType]] | Int32 | | 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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#StartPoint|StartPoint]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | Gets or sets a value representing the starting vertex of the routeSegment. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#StartPointAdjacentIds|StartPointAdjacentIds]] | Collection<String> | | Gets a value represents the adjacent feature ids of start point. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Weight|Weight]] | Single | | Gets or sets a value representing the weight of the routeSegment. It can represent, for example, the routeSegment length. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== RouteSegment() ==== | ||
| - | This is the default constructor for the class. | ||
| - | === Remarks === | ||
| - | This is the default constructor for the class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== RouteSegment(String, Int32, Single, PointShape, IEnumerable<String>, PointShape, IEnumerable<String>) ==== | ||
| - | This is the constructor for the class. | ||
| - | === Remarks === | ||
| - | This constructor allows you to provide the information for the routeSegment. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | featureId | String<!-- System.String --> | 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 | Int32<!-- System.Int32 --> | 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 | Single<!-- System.Single --> | This parameter is the weight of the routeSegment. It can represent, for example, the routeSegment length. | | ||
| - | | startPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the starting vertex of the routeSegment. | | ||
| - | | startPointAdjacentIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is the adjacent feature IDs of the start point. | | ||
| - | | endPoint | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | This parameter is the ending vertex of the routeSegment. | | ||
| - | | endPointAdjacentIds | IEnumerable<String><!-- System.Collections.Generic.IEnumerable{System.String} --> | This parameter is the adjacent feature IDs of the end point. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Distance ==== | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Distance" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Distance</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#DrivingDirection" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#DrivingDirection</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Routing.DrivingDirection|DrivingDirection]]<!-- ThinkGeo.MapSuite.Routing.DrivingDirection --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPoint" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPoint</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPointAdjacentIds" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#EndPointAdjacentIds</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#FeatureId" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#FeatureId</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#RouteSegmentType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#RouteSegmentType</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPoint" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPoint</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPointAdjacentIds" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#StartPointAdjacentIds</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== 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:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Weight" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RouteSegment#Weight</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.Routing.RouteSegment --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteRouting]] | ||
| - | [[Category:ThinkGeo.MapSuite.Routing]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.routing.routesegment.1440040134.txt.gz ยท Last modified: 2015/09/18 03:06 (external edit)
