Differences

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

--- thinkgeo.mapsuite.routing.gettingrouteviavisitstopsroutingengineeventargs [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.routing.gettingrouteviavisitstopsroutingengineeventargs [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
-This class represents the parameters passed out through the GettingTspVisitRoute event.
-=== Remarks ===
 This class represents the parameters passed out through the GettingTspVisitRoute event.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**System.EventArgs
+    *System.EventArgs
-***[[ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs]]
+      ***ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#GettingRouteViaVisitStopsRoutingEngineEventArgs()|GettingRouteViaVisitStopsRoutingEngineEventArgs]]   |    |    | This is the default constructor with no parameters   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>)|GettingRouteViaVisitStopsRoutingEngineEventArgs]]   | IEnumerable<Int32>, IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>   |    | This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>, Boolean)|GettingRouteViaVisitStopsRoutingEngineEventArgs]]   | IEnumerable<Int32>, IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>, Boolean   |    | This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.   |
-==== Protected Constructors ====
+This is the default constructor with no parameters
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
+N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>,IEnumerable<RouteSegment>) **
-==== Public Methods ====
+This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
+This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
+== Parameters ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
+  * //visitSequence//
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
+    * Type:IEnumerable<Int32>
+    * Description:The current bestVisitSequence of locations that you want to pass out by event.
-==== Protected Methods ====
+  * //routeSegments//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+    * Description:The RouteSement collection that represents current route
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+<div newline></div>
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>,IEnumerable<RouteSegment>,Boolean) **
-| {{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}}[[#Terminate|Terminate]]   | Boolean   |    | Gets or sets the value that allows you stops the calculating and return current result. The default value is false.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TotalDistance|TotalDistance]]   | Double   |    | The totalCost of current route   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#VisitSequence|VisitSequence]]   | Collection<Int32>   |    | Gets a number collection that represent the order in which the stops are visited.   |
-==== Protected Properties ====
+This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+== Remarks ==
+This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
+== Parameters ==
+  * //visitSequence//
+    * Type:IEnumerable<Int32>
+    * Description:The current bestVisitSequence of locations that you want to pass out by event.
-==== Public Events ====
+  * //routeSegments//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
+    * Description:A collection of route segments representing the route.
-===== Public Constructors =====
+  * //terminated//
-==== GettingRouteViaVisitStopsRoutingEngineEventArgs() ====
+    * Type:Boolean
-This is the default constructor with no parameters
+    * Description:A value represents whether stops current calculating.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#GettingRouteViaVisitStopsRoutingEngineEventArgs.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#GettingRouteViaVisitStopsRoutingEngineEventArgs.28.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+<div newline></div>
-==== GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>) ====
+==== Protected Constructors ====
-This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
+==== Public Methods ====
-=== Remarks ===
+** {{wiki:PublicMethod.gif|}} ToString() **
-This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| visitSequence   | IEnumerable<Int32><!-- System.Collections.Generic.IEnumerable{System.Int32} -->   | The current bestVisitSequence of locations that you want to pass out by event.   |
-| routeSegments   | IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Routing.RouteSegment} -->   | The RouteSement collection that represents current route   |
-[[#Public Constructors|Go Back]]
+N/A
-==== GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>, Boolean) ====
+== Remarks ==
-This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
+N/A
-=== Remarks ===
-This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| visitSequence   | IEnumerable<Int32><!-- System.Collections.Generic.IEnumerable{System.Int32} -->   | The current bestVisitSequence of locations that you want to pass out by event.   |
-| routeSegments   | IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Routing.RouteSegment} -->   | A collection of route segments representing the route.   |
-| terminated   | Boolean<!-- System.Boolean -->   | A value represents whether stops current calculating.   |
-[[#Public Constructors|Go Back]]
+== Return Value ==
-===== Protected Constructors =====
+  * Type:String
-===== Public Methods =====
+  * Description:N/A
-==== 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.GettingRouteViaVisitStopsRoutingEngineEventArgs#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#Equals.28Object.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| obj   | Object<!-- System.Object -->   |    |
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- System.Object -->
+N/A
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetHashCode() ====
+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.GettingRouteViaVisitStopsRoutingEngineEventArgs#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#GetHashCode.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //obj//
-==== GetType() ====
+    * Type:Object
-=== Remarks ===
+    * Description:N/A
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#GetType.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-<!-- System.Object -->
+N/A
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== ToString() ====
+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.GettingRouteViaVisitStopsRoutingEngineEventArgs#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#ToString.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-===== Protected Methods =====
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Finalize() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#Finalize.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+N/A
-^  Name ^  Type ^  Description ^
+== Remarks ==
+N/A
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== MemberwiseClone() ====
+  * 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.GettingRouteViaVisitStopsRoutingEngineEventArgs#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#MemberwiseClone.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-<!-- System.Object -->
+N/A
-[[#Protected Methods|Go Back]]
+== Remarks ==
-===== Public Properties =====
+N/A
-==== RouteSegments ====
-Gets a collection of route segments representing the route.
+== Return Value ==
-=== Remarks ===
+  * Type:Void
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#RouteSegments" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#RouteSegments</a>
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^
+== Parameters ==
-| Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} -->   |
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} Terminate **
-<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs -->
-[[#Public Properties|Go Back]]
-==== Terminate ====
 Gets or sets the value that allows you stops the calculating and return current result. The default value is false.
-=== Remarks ===
+== Remarks ==
 If you set the value to true, it will stops the calculating and return current result.
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Boolean
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs -->
+** {{wiki:PublicProperty.gif|}} RouteSegments **
-[[#Public Properties|Go Back]]
-==== TotalDistance ====
+Gets a collection of route segments representing the route.
-The totalCost of current route
+== Remarks ==
-=== Remarks ===
+N/A
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#TotalDistance" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#TotalDistance</a>
+== Return Value ==
-=== Return Value ===
+  * Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
-^ Return Type ^
-| Double<!-- System.Double -->   |
+** {{wiki:PublicProperty.gif|}} VisitSequence **
-<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs -->
-[[#Public Properties|Go Back]]
-==== VisitSequence ====
 Gets a number collection that represent the order in which the stops 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.GettingRouteViaVisitStopsRoutingEngineEventArgs#VisitSequence" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#VisitSequence</a>
+N/A
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Collection<Int32>
-| Collection<Int32><!-- System.Collections.ObjectModel.Collection{System.Int32} -->   |
-<!-- ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs -->
+** {{wiki:PublicProperty.gif|}} TotalDistance **
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
+The totalCost of current route
-===== Public Events =====
+== Remarks ==
-__NOTOC__
+N/A
-[[Category:MapSuiteRouting]]
+== Return Value ==
-[[Category:ThinkGeo.MapSuite.Routing]]
+  * Type:Double
-[[Category:UpdateDocumentation]]
+==== Protected Properties ====
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools