Module Task_Manager
This module contains the TASK_MANAGER class and derived classes.
1) Task_Manager#TASK_MANAGER class, extends Fsm#FSM
The Task_Manager#TASK_MANAGER class defines the core functions to report tasks to groups. Reportings can be done in several manners, and it is up to the derived classes if TASK_MANAGER to model the reporting behaviour.
1.1) TASK_MANAGER constructor:
* Task_Manager#TASK_MANAGER.New(): Create a new TASK_MANAGER instance.
1.2) TASK_MANAGER reporting:
Derived TASK_MANAGER classes will manage tasks using the method Task_Manager#TASK_MANAGER.ManageTasks(). This method implements polymorphic behaviour.
The time interval in seconds of the task management can be changed using the methods Task_Manager#TASK_MANAGER.SetRefreshTimeInterval(). To control how long a reporting message is displayed, use Task_Manager#TASK_MANAGER.SetReportDisplayTime(). Derived classes need to implement the method Task_Manager#TASK_MANAGER.GetReportDisplayTime() to use the correct display time for displayed messages during a report.
Task management can be started and stopped using the methods Task_Manager#TASK_MANAGER.StartTasks() and Task_Manager#TASK_MANAGER.StopTasks() respectively. If an ad-hoc report is requested, use the method Task_Manager#TASK_MANAGER().
The default task management interval is every 60 seconds.
Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing
Author: FlightControl - Framework Design & Programming
Global(s)
TASK_MANAGER |
Type TASK_MANAGER
Global(s)
Type Task_Manager
Type TASK_MANAGER
Extends Core.Fsm#FSM
TASK_MANAGER class.
Field(s)
- #string TASK_MANAGER.ClassName
- TASK_MANAGER:ManageTasks()
-
Manages the tasks for the Core.Set#SET_GROUP.
Return value
#TASK_MANAGER: self
- TASK_MANAGER:New(SetGroup)
-
TASK_MANAGER constructor.
Parameter
-
Core.Set#SET_GROUP SetGroup
: The set of group objects containing players for which tasks are managed.
Return value
#TASK_MANAGER: self
-
- TASK_MANAGER:OnAfterAborted(From, Event, To, Task)
-
Aborted Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
: -
Tasking.Task#TASK Task
:
-
- TASK_MANAGER:OnAfterCancelled(From, Event, To, Task)
-
Cancelled Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
: -
Tasking.Task#TASK Task
:
-
- TASK_MANAGER:OnAfterFailed(From, Event, To, Task)
-
Failed Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
: -
Tasking.Task#TASK Task
:
-
- TASK_MANAGER:OnAfterStartTasks(From, Event, To)
-
StartTasks Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
:
-
- TASK_MANAGER:OnAfterStopTasks(From, Event, To)
-
StopTasks Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
:
-
- TASK_MANAGER:OnAfterSuccess(From, Event, To, Task)
-
Success Handler OnAfter for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
: -
Tasking.Task#TASK Task
:
-
- TASK_MANAGER:OnBeforeStartTasks(From, Event, To)
-
StartTasks Handler OnBefore for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
:
Return value
#boolean:
-
- TASK_MANAGER:OnBeforeStopTasks(From, Event, To)
-
StopTasks Handler OnBefore for TASK_MANAGER
Parameters
-
#string From
: -
#string Event
: -
#string To
:
Return value
#boolean:
-
- Core.Set#SET_GROUP TASK_MANAGER.SetGroup
-
The set of group objects containing players for which tasks are managed.
- TASK_MANAGER:SetRefreshTimeInterval(RefreshTimeInterval)
-
Set the refresh time interval in seconds when a new task management action needs to be done.
Parameter
-
#number RefreshTimeInterval
: The refresh time interval in seconds when a new task management action needs to be done.
Return value
#TASK_MANAGER: self
-
- TASK_MANAGER:StartTasks()
-
StartTasks Trigger for TASK_MANAGER
- TASK_MANAGER:StopTasks()
-
StopTasks Trigger for TASK_MANAGER
- TASK_MANAGER:__StartTasks(Delay)
-
StartTasks Asynchronous Trigger for TASK_MANAGER
Parameter
-
#number Delay
:
-
- TASK_MANAGER:__StopTasks(Delay)
-
StopTasks Asynchronous Trigger for TASK_MANAGER
Parameter
-
#number Delay
:
-
- TASK_MANAGER:onafterManage(From, Event, To)
-
Parameters
-
From
: -
Event
: -
To
:
-
- TASK_MANAGER:onafterStartTasks(From, Event, To)
-
Parameters
-
From
: -
Event
: -
To
:
-