mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
b81b483f0b
So, when the Scheduler that is passed to the AddScheduler is nillified, the internal arrays that keep the Scheduler reference are also nillified. And it does what i need for further utilization in MOOSE classes. When the Scheduler is nillified, but, a schedule was planned for that Scheduler, once the scheduler fires off, it will ignore that call... cool. Sven
93 lines
3.1 KiB
Lua
93 lines
3.1 KiB
Lua
--- This module contains the SCHEDULER class.
|
|
--
|
|
-- 1) @{Core.Scheduler#SCHEDULER} class, extends @{Core.Base#BASE}
|
|
-- =====================================================
|
|
-- The @{Core.Scheduler#SCHEDULER} class models time events calling given event handling functions.
|
|
--
|
|
-- 1.1) SCHEDULER constructor
|
|
-- --------------------------
|
|
-- The SCHEDULER class is quite easy to use:
|
|
--
|
|
-- * @{Core.Scheduler#SCHEDULER.New}: Setup a new scheduler and start it with the specified parameters.
|
|
--
|
|
-- 1.2) SCHEDULER timer stop and start
|
|
-- -----------------------------------
|
|
-- The SCHEDULER can be stopped and restarted with the following methods:
|
|
--
|
|
-- * @{Core.Scheduler#SCHEDULER.Start}: (Re-)Start the scheduler.
|
|
-- * @{Core.Scheduler#SCHEDULER.Stop}: Stop the scheduler.
|
|
--
|
|
-- 1.3) Reschedule new time event
|
|
-- ------------------------------
|
|
-- With @{Core.Scheduler#SCHEDULER.Schedule} a new time event can be scheduled.
|
|
--
|
|
-- ===
|
|
--
|
|
-- ### Contributions:
|
|
--
|
|
-- * Mechanist : Concept & Testing
|
|
--
|
|
-- ### Authors:
|
|
--
|
|
-- * FlightControl : Design & Programming
|
|
--
|
|
-- ===
|
|
--
|
|
-- @module Scheduler
|
|
|
|
|
|
--- The SCHEDULER class
|
|
-- @type SCHEDULER
|
|
-- @field #number ScheduleID the ID of the scheduler.
|
|
-- @extends Core.Base#BASE
|
|
SCHEDULER = {
|
|
ClassName = "SCHEDULER",
|
|
}
|
|
|
|
--- SCHEDULER constructor.
|
|
-- @param #SCHEDULER self
|
|
-- @param #table TimeEventObject Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.
|
|
-- @param #function TimeEventFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in TimeEventFunctionArguments.
|
|
-- @param #table TimeEventFunctionArguments Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
|
|
-- @param #number StartSeconds Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
|
|
-- @param #number RepeatSecondsInterval Specifies the interval in seconds when the scheduler will call the event function.
|
|
-- @param #number RandomizationFactor Specifies a randomization factor between 0 and 1 to randomize the RepeatSecondsInterval.
|
|
-- @param #number StopSeconds Specifies the amount of seconds when the scheduler will be stopped.
|
|
-- @return #SCHEDULER self
|
|
function SCHEDULER:New( TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds )
|
|
local self = BASE:Inherit( self, BASE:New() )
|
|
self:F2( { StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds } )
|
|
|
|
self.TimeEventObject = TimeEventObject
|
|
self.TimeEventFunction = TimeEventFunction
|
|
self.TimeEventFunctionArguments = TimeEventFunctionArguments
|
|
self.StartSeconds = StartSeconds
|
|
self.Repeat = false
|
|
self.RepeatSecondsInterval = RepeatSecondsInterval or 0
|
|
self.RandomizationFactor = RandomizationFactor or 0
|
|
self.StopSeconds = StopSeconds
|
|
|
|
self.StartTime = timer.getTime()
|
|
|
|
_TIMERDISPATCHER:AddSchedule( self )
|
|
|
|
return self
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|