Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.routing.gettingrouteviavisitstopsroutingengineeventargs
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs
<!– 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.EventArgs *ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 GettingRouteViaVisitStopsRoutingEngineEventArgs | This is the default constructor with no parameters | ||
| GettingRouteViaVisitStopsRoutingEngineEventArgs | IEnumerable<Int32>, IEnumerable<RouteSegment> | This is the constructor that passed the current bestVisitSequence of locations and default isTermination value “false” | |
| GettingRouteViaVisitStopsRoutingEngineEventArgs | IEnumerable<Int32>, IEnumerable<RouteSegment>, Boolean | This is the constructor that passed the current bestVisitSequence of locations and a value representing whether stops current calculating. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 RouteSegments | Collection<RouteSegment> | Gets a collection of route segments representing the route. | |
| Terminate | Boolean | Gets or sets the value that allows you stops the calculating and return current result. The default value is false. | |
| TotalDistance | Double | The totalCost of current route | |
| VisitSequence | Collection<Int32> | Gets a number collection that represent the order in which the stops are visited. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
GettingRouteViaVisitStopsRoutingEngineEventArgs()
This is the default constructor with no parameters
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 |
|---|
GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>)
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
| 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<RouteSegment><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Routing.RouteSegment} –> | The RouteSement collection that represents current route |
GettingRouteViaVisitStopsRoutingEngineEventArgs(IEnumerable<Int32>, IEnumerable<RouteSegment>, 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
| 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<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. |
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.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
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> 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.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
| Name | Type | Description |
|---|
<!– System.Object –> 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.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
| Name | Type | Description |
|---|
<!– System.Object –> 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.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
| Name | Type | Description |
|---|
<!– System.Object –> 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.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
| Name | Type | Description |
|---|
<!– System.Object –> 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.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
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
RouteSegments
Gets a collection of route segments representing 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.GettingRouteViaVisitStopsRoutingEngineEventArgs#RouteSegments” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs#RouteSegments</a>
Return Value
| Return Type |
|---|
| Collection<RouteSegment><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Routing.RouteSegment} –> |
<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> Go Back
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
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> Go Back
TotalDistance
The totalCost of current route
Remarks
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 Type |
|---|
| Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> Go Back
VisitSequence
Gets a number collection that represent the order in which the stops are visited.
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>
Return Value
| Return Type |
|---|
| Collection<Int32><!– System.Collections.ObjectModel.Collection{System.Int32} –> |
<!– ThinkGeo.MapSuite.Routing.GettingRouteViaVisitStopsRoutingEngineEventArgs –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.routing.gettingrouteviavisitstopsroutingengineeventargs.1440040134.txt.gz · Last modified: 2015/09/18 03:06 (external edit)
