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.
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 |
|---|---|
|
The DETECTION_BASE object that is used to report the detected objects. |
|
|
Get the reporting message display time. |
|
|
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. |
|
|
The groups to which the FAC will report to. |
|
DETECTION_MANAGER:SetRefreshTimeInterval(RefreshTimeInterval) |
Set the reporting time interval. |
|
Set the reporting message display time. |
|
|
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 FSM | Description |
|---|---|
|
Adds an End state. |
|
DETECTION_MANAGER:AddProcess(From, Event, Process, ReturnEvents) |
Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
Adds a score for the FSM to be achieved. |
|
DETECTION_MANAGER:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
DETECTION_MANAGER:_call_handler(step, trigger, params, EventName) |
|
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
DETECTION_MANAGER:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
|
Creation of a Crash Event. |
|
|
Creation of a Dead Event. |
|
DETECTION_MANAGER:CreateEventRemoveUnit(EventTime, Initiator) |
Creation of a Remove Unit Event. |
|
Creation of a Takeoff Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an object is completely destroyed. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on. |
|
|
Occurs when a mission ends |
|
|
Occurs when a mission starts |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
DETECTION_MANAGER:ScheduleOnce(Start, SchedulerFunction, ...) |
Schedule a new time event. |
DETECTION_MANAGER:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default. |
|
|
UnSubscribe to a DCS event. |
|
DETECTION_MANAGER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
DETECTION_MANAGER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
| 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 Detection. |
|
|
DETECTION_REPORTING constructor. |
|
|
Reports the detected items to the Core.Set#SET_GROUP. |
|
|
The groups to which the FAC will report to. |
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
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.
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 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
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
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Set the default Process template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
An sub-process FSM.
#table ReturnEvents
A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
Return value:
The SubFSM.
Adds a score for the FSM to be achieved.
Defined in:
Parameters:
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Adds a score for the FSM_PROCESS to be achieved.
Defined in:
Parameters:
#string From
is the From State of the main process.
#string Event
is the Event of the main process.
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Add a new transition rule to the FSM.
A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
#string To
The To state.
Defined in:
Returns a table of the SubFSM rules defined within the FSM.
Returns the start state of the FSM.
Defined in:
Returns a table of the transition rules defined within the FSM.
Sets the start state of the FSM.
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
This is the worker method to retrieve the Parent class.
Note that the Parent class must be passed to call the parent class method.
self:GetParent(self):ParentMethod()
Defined in:
Parameters:
#BASE Child
is the Child class from which the Parent class needs to be retrieved.
FromClass
Return value:
Get a Value given a Key from the Object.
Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS Event
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#boolean:
Enquires if tracing is on (for the class).
BASE constructor.
This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
function EVENT:New()
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
Occurs when an object is completely destroyed.
initiator : The unit that is was destroyed.
Occurs when a ground unit captures either an airbase or a farp.
initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
initiator : The unit that has crashed
Occurs when an object is dead.
initiator : The unit that is dead.
Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
initiator : The unit that had the failure
Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
Can be an Airbase Object, FARP, or Ships
Occurs when a mission ends
Occurs when a mission starts
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.
Occurs when any player assumes direct control of a unit.
initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
initiator : The unit that was receiving fuel.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. initiator : The unit that was doing the shooing.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooing. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
Occurs when an aircraft takes off from an airbase, farp, or ship.
initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#number:
The ScheduleID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#number:
The ScheduleID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
Set the Class Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace level
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.
Defined in:
Parameter:
#boolean TraceOnOff
Switch the tracing on or off.
Usage:
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )UnSubscribe to a DCS event.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event event
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 Detection.
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.