Class RouteVoyagerHelper

Helper methods for ICamApiRouteVoyager

Inheritance

object

RouteVoyagerHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class RouteVoyagerHelper

Methods

AddPoint5D(ComWrapper<ICamApiRouteVoyager>, TST5DPoint)

Add a 5D point to the route. Returns the zero-based index assigned to the point.

Declaration

public static int AddPoint5D(this ComWrapper<ICamApiRouteVoyager> voyagerCom, TST5DPoint point)

Parameters

Type	Name	Description
ComWrapper<ICamApiRouteVoyager>	voyagerCom
TST5DPoint	point

Returns

Type	Description
int

Create()

Create a fresh ICamApiRouteVoyager instance. The voyager carries state (added points, GroupByPlanes flag) and has no Reset method, so prefer creating a new instance per logical route rather than reusing a singleton.

Declaration

public static ComWrapper<ICamApiRouteVoyager> Create()

Returns

Type	Description
ComWrapper<ICamApiRouteVoyager>

GetOptimalRoute(ComWrapper<ICamApiRouteVoyager>, ICamApiRouteVoyagerGetOptimalRouteCallback)

Compute the optimal route through all added points and invoke callback.ExecuteAction(idx) for each point in the optimal order. Throws on rsError.

Declaration

public static void GetOptimalRoute(this ComWrapper<ICamApiRouteVoyager> voyagerCom, ICamApiRouteVoyagerGetOptimalRouteCallback callback)

Parameters

Type	Name	Description
ComWrapper<ICamApiRouteVoyager>	voyagerCom
ICamApiRouteVoyagerGetOptimalRouteCallback	callback

GroupByPlanes(ComWrapper<ICamApiRouteVoyager>)

Group points by planes before optimisation. Affects the grouping strategy of the optimiser.

Declaration

public static bool GroupByPlanes(this ComWrapper<ICamApiRouteVoyager> voyagerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiRouteVoyager>	voyagerCom

Returns

Type	Description
bool

SetGroupByPlanes(ComWrapper<ICamApiRouteVoyager>, bool)

Group points by planes before optimisation. Affects the grouping strategy of the optimiser.

Declaration

public static void SetGroupByPlanes(this ComWrapper<ICamApiRouteVoyager> voyagerCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiRouteVoyager>	voyagerCom
bool	value