mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
143 lines
4.4 KiB
Lua
143 lines
4.4 KiB
Lua
--- Models time events calling event handing functions.
|
|
--
|
|
-- @{SCHEDULER} class
|
|
-- ===================
|
|
-- The @{SCHEDULER} class models time events calling given event handling functions.
|
|
--
|
|
-- SCHEDULER constructor
|
|
-- =====================
|
|
-- The SCHEDULER class is quite easy to use:
|
|
--
|
|
-- * @{#SCHEDULER.New}: Setup a new scheduler and start it with the specified parameters.
|
|
--
|
|
-- SCHEDULER timer methods
|
|
-- =======================
|
|
-- The SCHEDULER can be stopped and restarted with the following methods:
|
|
--
|
|
-- * @{#SCHEDULER.Start}: (Re-)Start the scheduler.
|
|
-- * @{#SCHEDULER.Start}: Stop the scheduler.
|
|
--
|
|
-- @module Scheduler
|
|
-- @author FlightControl
|
|
|
|
Include.File( "Routines" )
|
|
Include.File( "Base" )
|
|
|
|
|
|
--- The SCHEDULER class
|
|
-- @type SCHEDULER
|
|
-- @extends Base#BASE
|
|
SCHEDULER = {
|
|
ClassName = "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( { TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds } )
|
|
|
|
self.TimeEventObject = TimeEventObject
|
|
self.TimeEventFunction = TimeEventFunction
|
|
self.TimeEventFunctionArguments = TimeEventFunctionArguments
|
|
self.StartSeconds = StartSeconds
|
|
|
|
if RepeatSecondsInterval then
|
|
self.RepeatSecondsInterval = RepeatSecondsInterval
|
|
else
|
|
self.RepeatSecondsInterval = 0
|
|
end
|
|
|
|
if RandomizationFactor then
|
|
self.RandomizationFactor = RandomizationFactor
|
|
else
|
|
self.RandomizationFactor = 0
|
|
end
|
|
|
|
if StopSeconds then
|
|
self.StopSeconds = StopSeconds
|
|
end
|
|
|
|
self.Repeat = false
|
|
|
|
self.StartTime = timer.getTime()
|
|
|
|
self:Start()
|
|
|
|
return self
|
|
end
|
|
|
|
--- (Re-)Starts the scheduler.
|
|
-- @param #SCHEDULER self
|
|
-- @return #SCHEDULER self
|
|
function SCHEDULER:Start()
|
|
self:F2( self.TimeEventObject )
|
|
|
|
self.Repeat = true
|
|
timer.scheduleFunction( self._Scheduler, self, timer.getTime() + self.StartSeconds + .01 )
|
|
|
|
return self
|
|
end
|
|
|
|
--- Stops the scheduler.
|
|
-- @param #SCHEDULER self
|
|
-- @return #SCHEDULER self
|
|
function SCHEDULER:Stop()
|
|
self:F2( self.TimeEventObject )
|
|
|
|
self.Repeat = false
|
|
|
|
return self
|
|
end
|
|
|
|
-- Private Functions
|
|
|
|
function SCHEDULER:_Scheduler()
|
|
self:F2( self.TimeEventFunctionArguments )
|
|
|
|
local ErrorHandler = function( errmsg )
|
|
|
|
env.info( "Error in SCHEDULER function:" .. errmsg )
|
|
env.info( debug.traceback() )
|
|
|
|
return errmsg
|
|
end
|
|
|
|
local Status, Result
|
|
if self.TimeEventObject then
|
|
Status, Result = xpcall( function() return self.TimeEventFunction( self.TimeEventObject, unpack( self.TimeEventFunctionArguments ) ) end, ErrorHandler )
|
|
else
|
|
Status, Result = xpcall( function() return self.TimeEventFunction( unpack( self.TimeEventFunctionArguments ) ) end, ErrorHandler )
|
|
end
|
|
|
|
self:T( { Status, Result } )
|
|
|
|
if Status and ( ( not Result ) or ( Result and Result ~= false ) ) then
|
|
if self.Repeat and ( not self.StopSeconds or ( self.StopSeconds and timer.getTime() <= self.StartTime + self.StopSeconds ) ) then
|
|
timer.scheduleFunction(
|
|
self._Scheduler,
|
|
self,
|
|
timer.getTime() + self.RepeatSecondsInterval + math.random( - ( self.RandomizationFactor * self.RepeatSecondsInterval / 2 ), ( self.RandomizationFactor * self.RepeatSecondsInterval / 2 ) ) + 0.01
|
|
)
|
|
end
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|