TaskExecuter
Inherits from Dispatcher
Description
A class that represents a Dispatcher that can also execute TaskSequences.
Properties
activeTask | Accesses the task that is currently being executed by the object. |
activeTaskSequence | Accesses the task sequence that is currently being executed by the object. |
navigator | Accesses the task executer's navigator, i.e. the object that manages travel tasks. |
Static Properties
DefaultEndSpeed | A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will be whatever the default for that task and/or navigator is. |
MaxEndSpeed | A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will be the task executer's max speed. |
ZeroEndSpeed | A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will always be zero. |
Details
TaskExecuter.activeTask
readonly TaskSequence.Task activeTask
Description
Accesses the task that is currently being executed by the object.
TaskExecuter obj = Model.find("Operator1");
int taskType = obj.activeTask.type;
...
TaskExecuter.activeTaskSequence
readonly TaskSequence activeTaskSequence
Description
Accesses the task sequence that is currently being executed by the object.
TaskExecuter obj = Model.find("Operator1");
double tsPriority = obj.activeTaskSequence.priority;
...
TaskExecuter.DefaultEndSpeed
static readonly int DefaultEndSpeed
Description
A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will be whatever the default for that task and/or navigator is.
This is an alias for the value 0. For travel tasks, by default an end speed value of 0 generally means end at max speed, whereas for offset tasks (load, unload, travel relative, travel to loc, etc.) the value 0 means zero end speed. This alias essentially means use whatever is the default for the task.
TaskExecuter.MaxEndSpeed
static readonly int MaxEndSpeed
Description
A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will be the task executer's max speed.
TaskExecuter.ZeroEndSpeed
static readonly int ZeroEndSpeed
Description
A property to enter for a task's end speed parameter. If this value is entered, then the task's end speed will always be zero.