====== ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs ======
{{section>upgrade_map_suite_to_10.0}}
This class represents the parameters passed out through the GettingTspVisitRoute event.
===== Inheritance Hierarchy =====
*System.Object
*System.EventArgs
***ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs() **
This is the default constructor with no parameters
== Remarks ==
N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable,IEnumerable) **
This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
== Remarks ==
This is the constructor that passed the current bestVisitSequence of locations and default isTermination value "false"
== Parameters ==
* //visitSequence//
* Type:IEnumerable
* Description:The current bestVisitSequence of locations that you want to pass out by event.
* //routeSegments//
* Type:IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
* Description:The RouteSement collection that represents current route
** {{wiki:PublicMethod.gif|}} GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable,IEnumerable,Boolean) **
This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
== Remarks ==
This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating.
== Parameters ==
* //visitSequence//
* Type:IEnumerable
* Description:The current bestVisitSequence of locations that you want to pass out by event.
* //routeSegments//
* Type:IEnumerable<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
* Description:A collection of route segments representing the route.
* //terminated//
* Type:Boolean
* Description:A value represents whether stops current calculating.
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} ToString() **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:String
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Boolean
* Description:N/A
== Parameters ==
* //obj//
* Type:Object
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Int32
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Type
* Description:N/A
== Parameters ==
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} Finalize() **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
N/A
== Remarks ==
N/A
== Return Value ==
* Type:Object
* Description:N/A
== Parameters ==
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Terminate **
Gets or sets the value that allows you stops the calculating and return current result. The default value is false.
== Remarks ==
If you set the value to true, it will stops the calculating and return current result.
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} RouteSegments **
Gets a collection of route segments representing the route.
== Remarks ==
N/A
== Return Value ==
* Type:Collection<[[ThinkGeo.MapSuite.Routing.RouteSegment|RouteSegment]]>
** {{wiki:PublicProperty.gif|}} VisitSequence **
Gets a number collection that represent the order in which the stops are visited.
== Remarks ==
N/A
== Return Value ==
* Type:Collection
** {{wiki:PublicProperty.gif|}} TotalDistance **
The totalCost of current route
== Remarks ==
N/A
== Return Value ==
* Type:Double
==== Protected Properties ====
==== Public Events ====