Module Tasking.DetectionManager
Tasking - This module contains the DETECTION_MANAGER class and derived classes.
The #DETECTION_MANAGER class defines the core functions to report detected objects to groups. Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.
1.1) DETECTION_MANAGER constructor:
* DETECTION_MANAGER.New(): Create a new DETECTION_MANAGER instance.
1.2) DETECTION_MANAGER reporting:
Derived DETECTION_MANAGER classes will reports detected units using the method DETECTION_MANAGER.ReportDetected(). This method implements polymorphic behaviour.
The time interval in seconds of the reporting can be changed using the methods DETECTION_MANAGER.SetRefreshTimeInterval(). To control how long a reporting message is displayed, use DETECTION_MANAGER.SetReportDisplayTime(). Derived classes need to implement the method DETECTION_MANAGER.GetReportDisplayTime() to use the correct display time for displayed messages during a report.
Reporting can be started and stopped using the methods DETECTION_MANAGER.StartReporting() and DETECTION_MANAGER.StopReporting() respectively. If an ad-hoc report is requested, use the method DETECTION_MANAGER.ReportNow().
The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.
2) #DETECTION_REPORTING class, extends #DETECTION_MANAGER
The #DETECTION_REPORTING class implements detected units reporting. Reporting can be controlled using the reporting methods available in the Tasking.DetectionManager#DETECTION_MANAGER class.
2.1) DETECTION_REPORTING constructor:
The DETECTION_REPORTING.New() method creates a new DETECTION_REPORTING instance.
Developer Note
Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated
Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing
Author: FlightControl - Framework Design & Programming
Global(s)
Global DETECTION_MANAGER |
DETECTION_MANAGER class. |
Global DETECTION_REPORTING |
Type(s)
| Fields and Methods inherited from DETECTION_MANAGER | Description |
|---|---|
|
Get the command center to communicate actions to the players. |
|
|
Get the reporting message display time. |
|
|
Send an information message to the players reporting to the command center. |
|
|
FAC constructor. |
|
|
Aborted Handler OnAfter for DETECTION_MANAGER |
|
|
Cancelled Handler OnAfter for DETECTION_MANAGER |
|
|
Failed Handler OnAfter for DETECTION_MANAGER |
|
|
Start Handler OnAfter for DETECTION_MANAGER |
|
|
Stop Handler OnAfter for DETECTION_MANAGER |
|
|
Success Handler OnAfter for DETECTION_MANAGER |
|
|
Start Handler OnBefore for DETECTION_MANAGER |
|
|
Stop Handler OnBefore for DETECTION_MANAGER |
|
|
Reports the detected items to the Core.Set#SET_GROUP. |
|
|
Set a command center to communicate actions to the players reporting to the command center. |
|
DETECTION_MANAGER:SetRefreshTimeInterval(RefreshTimeInterval) |
Set the reporting time interval. |
|
Set the reporting message display time. |
|
DETECTION_MANAGER:SetTacticalMenu(DispatcherMainMenuText, DispatcherMenuText) |
Set a command center to communicate actions to the players reporting to the command center. |
|
Start Trigger for DETECTION_MANAGER |
|
|
Stop Trigger for DETECTION_MANAGER |
|
|
Start Asynchronous Trigger for DETECTION_MANAGER |
|
|
Stop Asynchronous Trigger for DETECTION_MANAGER |
|
| Fields and Methods inherited from DETECTION_REPORTING | Description |
|---|---|
|
The DETECTION_BASE object that is used to report the detected objects. |
|
|
Creates a string of the detected items in a Functional.Detection object. |
|
|
DETECTION_REPORTING constructor. |
|
|
Reports the detected items to the Core.Set#SET_GROUP. |
|
|
The groups to which the FAC will report to. |
Field(s)
Function(s)
Get the command center to communicate actions to the players.
Defined in:
DETECTION_MANAGER
Return value:
The command center.
Get the reporting message display time.
Defined in:
DETECTION_MANAGER
Return value:
#number:
ReportDisplayTime The display time in seconds when a report needs to be done.
Send an information message to the players reporting to the command center.
Defined in:
DETECTION_MANAGER
Parameters:
#table Squadron
The squadron table.
#string Message
The message to be sent.
#string SoundFile
The name of the sound file .wav or .ogg.
#number SoundDuration
The duration of the sound.
#string SoundPath
The path pointing to the folder in the mission file.
Wrapper.Group#GROUP DefenderGroup
The defender group sending the message.
Return value:
self
FAC constructor.
Defined in:
DETECTION_MANAGER
Parameters:
Core.Set#SET_GROUP SetGroup
Functional.Detection#DETECTION_BASE Detection
Return value:
self
Aborted Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Tasking.Task#TASK Task
Cancelled Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Tasking.Task#TASK Task
Failed Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Tasking.Task#TASK Task
Start Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Stop Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Success Handler OnAfter for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Tasking.Task#TASK Task
Start Handler OnBefore for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Return value:
#boolean:
Stop Handler OnBefore for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameters:
#string From
#string Event
#string To
Return value:
#boolean:
Reports the detected items to the Core.Set#SET_GROUP.
Defined in:
DETECTION_MANAGER
Parameter:
Functional.Detection#DETECTION_BASE Detection
Return value:
self
Set a command center to communicate actions to the players reporting to the command center.
Defined in:
DETECTION_MANAGER
Parameter:
Tasking.CommandCenter#COMMANDCENTER CommandCenter
The command center.
Return value:
self
Set the reporting time interval.
Defined in:
DETECTION_MANAGER
Parameter:
#number RefreshTimeInterval
The interval in seconds when a report needs to be done.
Return value:
self
Set the reporting message display time.
Defined in:
DETECTION_MANAGER
Parameter:
#number ReportDisplayTime
The display time in seconds when a report needs to be done.
Return value:
self
Set a command center to communicate actions to the players reporting to the command center.
Defined in:
DETECTION_MANAGER
Parameters:
DispatcherMainMenuText
DispatcherMenuText
Return value:
self
Start Asynchronous Trigger for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameter:
#number Delay
Stop Asynchronous Trigger for DETECTION_MANAGER
Defined in:
DETECTION_MANAGER
Parameter:
#number Delay
Defined in:
DETECTION_MANAGER
Parameters:
From
Event
To
Defined in:
DETECTION_MANAGER
Parameters:
From
Event
To
DETECTION_REPORTING class.
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Creates a string of the detected items in a Functional.Detection object.
Defined in:
DETECTION_REPORTING
Parameter:
Core.Set#SET_UNIT DetectedSet
The detected Set created by the Functional.Detection#DETECTION_BASE object.
Return value:
self
DETECTION_REPORTING constructor.
Defined in:
DETECTION_REPORTING
Parameters:
Core.Set#SET_GROUP SetGroup
Functional.Detection#DETECTION_AREAS Detection
Return value:
self
Reports the detected items to the Core.Set#SET_GROUP.
Defined in:
DETECTION_REPORTING
Parameters:
Wrapper.Group#GROUP Group
The Wrapper.Group object to where the report needs to go.
Functional.Detection#DETECTION_AREAS Detection
The detection created by the Functional.Detection#DETECTION_BASE object.
Return value:
#boolean:
Return true if you want the reporting to continue... false will cancel the reporting loop.