User Tools

Site Tools

Trace:
thinkgeo.mapsuite.routing.routingresult

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.routing.routingresult [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.routing.routingresult [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Routing.RoutingResult ====== ====== ThinkGeo.MapSuite.Routing.RoutingResult ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class represents the result of routing. RoutingResult is the roads collection consisting of the route, turn-by-turn directions and other information like total distance and route path. This class represents the result of routing. RoutingResult is the roads collection consisting of the route, turn-by-turn directions and other information like total distance and route path.
-=== Remarks === 
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult</​a>​ 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.Routing.RoutingResult]]+    ***ThinkGeo.MapSuite.Routing.RoutingResult**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} RoutingResult() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#RoutingResult()|RoutingResult]] ​  ​| ​   |    | This is the class constructor. ​  |+
  
 +  * //This is the class constructor.//​
 +== Remarks ==
 +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RoutingResult.28.29//​
 +== Parameters ==
 +<div newline></​div>​
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ToString() ​**
-| {{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 ==== +  * //N/A// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#ToString.28.29//​
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:String 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Distance|Distance]] ​  | Double ​  ​| ​   | Gets or sets a value representing the distance of the route. ​  | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Features|Features]] ​  | Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]> ​  ​| ​   | Gets a collection of features representing the route. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​OrderedStops|OrderedStops]] ​  | Collection<​[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]> ​  ​| ​   | Gets a PointShape collection that represent the best order in which the locations are visited. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Route|Route]] ​  | [[ThinkGeo.MapSuite.Core.LineShape|LineShape]] ​  ​| ​   | Gets or sets established lines which consist of route segments. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​RouteSegments|RouteSegments]] ​  | Collection<​[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]> ​  ​| ​   | Gets a collection of route segments representing the route. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Weight|Weight]] ​  | Double ​  ​| ​   | Gets or sets a value representing the sum weight of the route. ​  |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
-==== Public Events ==== +  * //N/A// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Equals.28Object.29//​
  
-===== Public Constructors ===== +== Return Value == 
-==== RoutingResult() ==== +  * Type:Boolean 
-This is the class constructor. +  ​* Description:N/A
-=== Overloads === +
-This is the default constructor and requires you to set the properties after you create the class. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RoutingResult.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RoutingResult.28.29</​a>​ +
-=== Parameters === +
-^  Name ^  Type ^  ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-===== Protected Constructors ===== +  ​* ​//obj// 
-===== Public Methods ===== +    ​* ​Type:Object 
-==== Equals(Object) ==== +    ​* Description:​N/​A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.RoutingResult#​Equals.28Object.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Equals.28Object.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-| obj   | Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-==== GetHashCode() ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetHashCode.28.29//​
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetHashCode.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetHashCode.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Int32 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></div> 
-==== GetType() ​==== +** {{wiki:​PublicMethod.gif|}} GetType() **
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetType.28.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetType.28.29</a> +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​GetType.28.29//​
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Type 
-==== ToString() ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​ToString.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​ToString.28.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-===== Protected Methods ===== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Finalize.28.29//​
-==== Finalize() ==== +
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Finalize.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Finalize.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></div> 
-==== MemberwiseClone() ​==== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​MemberwiseClone.28.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​MemberwiseClone.28.29</a> +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​MemberwiseClone.28.29//​
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Object 
-===== Public Properties ===== +  * Description:​N/​A
-==== Distance ==== +
-Gets or sets a value representing the distance of the route. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Distance"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Distance</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ +
-| Double<​!-- System.Double --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> +== Parameters ​== 
-[[#Public Properties|Go Back]] +<div newline></div> 
-==== Features ​==== +==== Public Properties ==== 
-Gets a collection of features representing the route. +** {{wiki:​PublicProperty.gif|}} OrderedStops **
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Features"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Features</a> +
-=== Return Value === +
-^ Return Type ^ +
-| Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Feature} --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> 
-[[#Public Properties|Go Back]] 
-==== OrderedStops ==== 
 Gets a PointShape collection that represent the best order in which the locations are visited. Gets a PointShape collection that represent the best order in which the locations are visited.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​OrderedStops" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​OrderedStops</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​OrderedStops 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:Collection<​[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]>​ 
-| Collection<​[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]>​<!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.PointShape} --> ​  |+ 
 +** {{wiki:​PublicProperty.gif|}} Route **
  
-<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> 
-[[#Public Properties|Go Back]] 
-==== Route ==== 
 Gets or sets established lines which consist of route segments. Gets or sets established lines which consist of route segments.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Route" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Route</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Route 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:[[ThinkGeo.MapSuite.Core.LineShape|LineShape]]
-| [[ThinkGeo.MapSuite.Core.LineShape|LineShape]]<!-- ThinkGeo.MapSuite.Core.LineShape --> ​  |+
  
-<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> +** {{wiki:​PublicProperty.gif|}} Distance ** 
-[[#Public Properties|Go Back]] + 
-==== RouteSegments ==== +Gets or sets a value representing ​the distance of the route. 
-Gets a collection of route segments ​representing the route. +== Remarks == 
-=== Remarks ​=== +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Distance 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RouteSegments"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RouteSegments</​a>​ +== Return Value == 
-=== Return Value === +  ​* ​Type:Double 
-^ Return ​Type ^ + 
-| Collection<​[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><​!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} --> ​  |+** {{wiki:​PublicProperty.gif|}} Weight **
  
-<!-- ThinkGeo.MapSuite.Routing.RoutingResult --> 
-[[#Public Properties|Go Back]] 
-==== Weight ==== 
 Gets or sets a value representing the sum weight of the route. Gets or sets a value representing the sum weight of the route.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Weight" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Weight</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​Weight 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:Double
-| Double<​!-- System.Double ​--> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.Routing.RoutingResult ​--> +** {{wiki:​PublicProperty.gif|}} Features ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ===== +Gets a collection of features representing the route. 
-===== Public Events ​===== +== Remarks == 
-__NOTOC__ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#Features 
-[[Category:​MapSuiteRouting]] +== Return Value == 
-[[Category:ThinkGeo.MapSuite.Routing]] +  * Type:​Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]> 
-[[Category:​UpdateDocumentation]]+ 
 +** {{wiki:​PublicProperty.gif|}} RouteSegments ** 
 + 
 +Gets a collection of route segments representing the route. 
 +== Remarks == 
 +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.Routing.RoutingResult#​RouteSegments 
 +== Return Value == 
 +  * Type:​Collection<​[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>​ 
 + 
 +==== Protected Properties ==== 
 +** {{wiki:​ProtectedProperty.gif|}} 1RQ= ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:​Collection<​Int32>​ 
 + 
 +** {{wiki:​ProtectedProperty.gif|}} 2BQ= ** 
 + 
 +N/A 
 +== Remarks ​== 
 +N/A 
 +== Return Value == 
 +  * Type:[[ThinkGeo.MapSuite.Core.MultilineShape|MultilineShape]] 
 + 
 +==== Public Events ====
  
thinkgeo.mapsuite.routing.routingresult.1440040134.txt.gz · Last modified: 2015/09/18 03:06 (external edit)

Page Tools