Navigator
Description
A class that represents a TaskExecuter's navigator. In other words, the object that manages travel tasks for the task executer.
Methods
| getCost | A generic method that gets route costing information associated with a TaskExecuter traveling from some origin to some destination. |
Details
Navigator.getCost()
| double getCost( Variant origin , Variant destination , Variant info ) |
Parameters
| origin | Navigator-dependent parameter defining the origin. For a default navigator, this must be a reference to a task executer. For a network navigator, it can also be a reference to a network node. For an AGV navigator, the origin may be either a reference to a TaskExecuter, or a reference to some object that is connected to a control point, or a control point. It can also be an array with two values, where the first value is an object, control point, or path, and the second value is an offset value representing an offset distance from that object on its associated path. For an A* navigator, the value can be an object reference or an array of three numbers representing a x/y/z model location. |
| destination | Navigator-dependent parameter defining the destination. This can take the same values as the origin parameter, except that it should not be a reference to a TaskExecuter. |
| info | Navigator-dependent parameter to modify how the cost is calculated. For an AGV navigator, if this parameter is a reference to a TaskExecuter, it will assume that agv-dependent cost calculations are to be associated with that object traveling in its current state. For a GIS navigator, a value of 1 will return distance, a value of 2 will return duration, and a value of 3 will return general cost. |
Description
A generic method that gets route costing information associated with a TaskExecuter traveling from some origin to some destination.
The implementation of this method is polymorphic as it depends somewhat on which navigator it is being called on. For example, a default navigator's getCost() will only work if you pass a TaskExecuter as the origin, and some other object as a destination, and it will return the same result as if you were to call distancetotravel(). On the other hand, a network navigator can take a network node as an origin and a network node as a destination. In this case, the result is the same as calling getnetworkdistance().