mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
OPS
This commit is contained in:
Frank
@@ -3,6 +3,7 @@
|
||||
-- ## Main Features:
|
||||
--
|
||||
-- * Define operation phases
|
||||
-- * Define conditions when phases are over
|
||||
-- * Dedicate resources to operations
|
||||
--
|
||||
-- ===
|
||||
@@ -31,6 +32,7 @@
|
||||
-- @field #table phases Phases.
|
||||
-- @field #number counterPhase Running number counting the phases.
|
||||
-- @field #OPERATION.Phase phase Currently active phase (if any).
|
||||
-- @field #table targets Targets.
|
||||
--
|
||||
-- @extends Core.Fsm#FSM
|
||||
|
||||
@@ -51,6 +53,7 @@ OPERATION = {
|
||||
legions = {},
|
||||
phases = {},
|
||||
counterPhase = 0,
|
||||
targets = {},
|
||||
}
|
||||
|
||||
--- Global mission counter.
|
||||
@@ -61,7 +64,18 @@ _OPERATIONID=0
|
||||
-- @field #number uid Unique ID of the phase.
|
||||
-- @field #string name Name of the phase.
|
||||
-- @field Core.Condition#CONDITION conditionOver Conditions when the phase is over.
|
||||
-- @field #boolean isOver If `true`, phase is over.
|
||||
-- @field #string status Phase status.
|
||||
|
||||
--- Operation phase.
|
||||
-- @type OPERATION.PhaseStatus
|
||||
-- @field #string PLANNED Planned.
|
||||
-- @field #string ACTIVE Active phase.
|
||||
-- @field #string OVER Phase is over.
|
||||
OPERATION.PhaseStatus={
|
||||
PLANNED="Planned",
|
||||
ACTIVE="Active",
|
||||
OVER="Over",
|
||||
}
|
||||
|
||||
--- OPERATION class version.
|
||||
-- @field #string version
|
||||
@@ -89,13 +103,15 @@ function OPERATION:New(Name)
|
||||
-- Increase global counter.
|
||||
_OPERATIONID=_OPERATIONID+1
|
||||
|
||||
-- Unique ID of the operation.
|
||||
self.uid=_OPERATIONID
|
||||
|
||||
-- Set Name.
|
||||
self.name=Name or string.format("Operation-%02d", _OPERATIONID)
|
||||
|
||||
-- Set log ID.
|
||||
self.lid=string.format("%s | ",self.name)
|
||||
|
||||
|
||||
-- FMS start state is PLANNED.
|
||||
self:SetStartState("Planned")
|
||||
|
||||
@@ -108,7 +124,7 @@ function OPERATION:New(Name)
|
||||
self:AddTransition("Running", "Pause", "Paused")
|
||||
self:AddTransition("Paused", "Unpause", "Running")
|
||||
|
||||
self:AddTransition("*", "ChangePhase", "*")
|
||||
self:AddTransition("*", "PhaseOver", "*")
|
||||
self:AddTransition("*", "PhaseChange", "*")
|
||||
|
||||
self:AddTransition("*", "Over", "Over")
|
||||
@@ -159,6 +175,43 @@ function OPERATION:New(Name)
|
||||
-- @param #string To To state.
|
||||
-- @param #OPERATION.Phase Phase The new phase.
|
||||
|
||||
|
||||
--- Triggers the FSM event "PhaseOver".
|
||||
-- @function [parent=#OPERATION] PhaseOver
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase that is over.
|
||||
|
||||
--- Triggers the FSM event "PhaseOver" after a delay.
|
||||
-- @function [parent=#OPERATION] __PhaseOver
|
||||
-- @param #OPERATION self
|
||||
-- @param #number delay Delay in seconds.
|
||||
-- @param #OPERATION.Phase Phase The phase that is over.
|
||||
|
||||
--- On after "PhaseOver" event.
|
||||
-- @function [parent=#OPERATION] OnAfterPhaseOver
|
||||
-- @param #OPERATION self
|
||||
-- @param #string From From state.
|
||||
-- @param #string Event Event.
|
||||
-- @param #string To To state.
|
||||
-- @param #OPERATION.Phase Phase The phase that is over.
|
||||
|
||||
|
||||
--- Triggers the FSM event "Over".
|
||||
-- @function [parent=#OPERATION] Over
|
||||
-- @param #OPERATION self
|
||||
|
||||
--- Triggers the FSM event "Over" after a delay.
|
||||
-- @function [parent=#OPERATION] __Over
|
||||
-- @param #OPERATION self
|
||||
-- @param #number delay Delay in seconds.
|
||||
|
||||
--- On after "Over" event.
|
||||
-- @function [parent=#OPERATION] OnAfterOver
|
||||
-- @param #OPERATION self
|
||||
-- @param #string From From state.
|
||||
-- @param #string Event Event.
|
||||
-- @param #string To To state.
|
||||
|
||||
-- Init status update.
|
||||
self:__StatusUpdate(-1)
|
||||
|
||||
@@ -172,9 +225,8 @@ end
|
||||
--- Create a new generic OPERATION object.
|
||||
-- @param #OPERATION self
|
||||
-- @param #string Name Name of the phase. Default "Phase-01" where the last number is a running number.
|
||||
-- @param Core.Condition#CONDITION ConditionOver Condition when the phase is over.
|
||||
-- @return #OPERATION.Phase Phase table object.
|
||||
function OPERATION:AddPhase(Name, ConditionOver)
|
||||
function OPERATION:AddPhase(Name)
|
||||
|
||||
-- Increase phase counter.
|
||||
self.counterPhase=self.counterPhase+1
|
||||
@@ -182,8 +234,8 @@ function OPERATION:AddPhase(Name, ConditionOver)
|
||||
local phase={} --#OPERATION.Phase
|
||||
phase.uid=self.counterPhase
|
||||
phase.name=Name or string.format("Phase-%02d", self.counterPhase)
|
||||
phase.conditionOver=ConditionOver or CONDITION:New(Name)
|
||||
phase.isOver=false
|
||||
phase.conditionOver=CONDITION:New(Name.." Over")
|
||||
phase.status=OPERATION.PhaseStatus.PLANNED
|
||||
|
||||
-- Add phase.
|
||||
table.insert(self.phases, phase)
|
||||
@@ -213,6 +265,7 @@ end
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:AssignCohort(Cohort)
|
||||
|
||||
self:T(self.lid..string.format("Assiging Cohort %s to operation", Cohort.name))
|
||||
self.cohorts[Cohort.name]=Cohort
|
||||
|
||||
end
|
||||
@@ -227,7 +280,60 @@ function OPERATION:AssignLegion(Legion)
|
||||
|
||||
end
|
||||
|
||||
--- Check if a given legion is assigned to this operation. All cohorts of this legion will be checked.
|
||||
-- @param #OPERATION self
|
||||
-- @param Ops.Legion#LEGION Legion The legion to be assigned.
|
||||
-- @return #boolean If `true`, legion is assigned to this operation.
|
||||
function OPERATION:IsAssignedLegion(Legion)
|
||||
|
||||
local legion=self.legions[Legion.alias]
|
||||
|
||||
if legion then
|
||||
self:T(self.lid..string.format("Legion %s is assigned to this operation", Legion.alias))
|
||||
return true
|
||||
else
|
||||
self:T(self.lid..string.format("Legion %s is NOT assigned to this operation", Legion.alias))
|
||||
return false
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
--- Check if a given cohort is assigned to this operation.
|
||||
-- @param #OPERATION self
|
||||
-- @param Ops.Cohort#COHORT Cohort The Cohort.
|
||||
-- @return #boolean If `true`, cohort is assigned to this operation.
|
||||
function OPERATION:IsAssignedCohort(Cohort)
|
||||
|
||||
local cohort=self.cohorts[Cohort.name]
|
||||
|
||||
if cohort then
|
||||
self:T(self.lid..string.format("Cohort %s is assigned to this operation", Cohort.name))
|
||||
return true
|
||||
else
|
||||
self:T(self.lid..string.format("Cohort %s is NOT assigned to this operation", Cohort.name))
|
||||
return false
|
||||
end
|
||||
|
||||
return nil
|
||||
end
|
||||
|
||||
--- Check if a given cohort or legion is assigned to this operation.
|
||||
-- @param #OPERATION self
|
||||
-- @param Wrapper.Object#OBJECT Object The cohort or legion object.
|
||||
-- @return #boolean If `true`, cohort is assigned to this operation.
|
||||
function OPERATION:IsAssignedCohortOrLegion(Object)
|
||||
|
||||
local isAssigned=nil
|
||||
if Object:IsInstanceOf("COHORT") then
|
||||
isAssigned=self:IsAssignedCohort(Object)
|
||||
elseif Object:IsInstanceOf("LEGION") then
|
||||
isAssigned=self:IsAssignedLegion(Object)
|
||||
else
|
||||
self:E(self.lid.."ERROR: Unknown Object!")
|
||||
end
|
||||
|
||||
return isAssigned
|
||||
end
|
||||
|
||||
--- Set start and stop time of the operation.
|
||||
-- @param #OPERATION self
|
||||
@@ -265,6 +371,88 @@ function OPERATION:SetTime(ClockStart, ClockStop)
|
||||
return self
|
||||
end
|
||||
|
||||
--- Set status of a phase.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @param #string Status New status, *e.g.* `OPERATION.PhaseStatus.OVER`.
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:SetPhaseStatus(Phase, Status)
|
||||
if Phase then
|
||||
self:T(self.lid..string.format("Phase %s status: %s-->%s"), Phase.status, Status)
|
||||
Phase.status=Status
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Get status of a phase.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @return #string Phase status, *e.g.* `OPERATION.PhaseStatus.OVER`.
|
||||
function OPERATION:GetPhaseStatus(Phase)
|
||||
return Phase.status
|
||||
end
|
||||
|
||||
--- Set codition when the given phase is over.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @param Core.Condition#CONDITION Condition Condition when the phase is over.
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:SetPhaseConditonOver(Phase, Condition)
|
||||
if Phase then
|
||||
self:T(self.lid..string.format("Setting phase %s conditon over %s"), Phase.name, Condition and Condition.name or "None")
|
||||
Phase.conditionOver=Condition
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Add codition function when the given phase is over. Must return a `#boolean`.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @param #function Function Function that needs to be `true`before the phase is over.
|
||||
-- @param ... Condition function arguments if any.
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:AddPhaseConditonOverAll(Phase, Function, ...)
|
||||
if Phase then
|
||||
Phase.conditionOver:AddFunctionAll(Function, ...)
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Add codition function when the given phase is over. Must return a `#boolean`.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @param #function Function Function that needs to be `true`before the phase is over.
|
||||
-- @param ... Condition function arguments if any.
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:AddPhaseConditonOverAny(Phase, Function, ...)
|
||||
if Phase then
|
||||
Phase.conditionOver:AddFunctionAny(Function, ...)
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
|
||||
--- Get codition when the given phase is over.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @return Core.Condition#CONDITION Condition when the phase is over (if any).
|
||||
function OPERATION:GetPhaseConditonOver(Phase, Condition)
|
||||
return Phase.conditionOver
|
||||
end
|
||||
|
||||
--- Get currrently active phase.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase.
|
||||
-- @param #string Status New status, e.g. `OPERATION.PhaseStatus.OVER`.
|
||||
-- @return #OPERATION self
|
||||
function OPERATION:SetPhaseStatus(Phase, Status)
|
||||
if Phase then
|
||||
self:T(self.lid..string.format("Phase \"%s\" status: %s-->%s", Phase.name, Phase.status, Status))
|
||||
Phase.status=Status
|
||||
end
|
||||
return self
|
||||
end
|
||||
|
||||
--- Get currrently active phase.
|
||||
-- @param #OPERATION self
|
||||
-- @return #OPERATION.Phase Current phase or `nil` if no current phase is active.
|
||||
@@ -272,6 +460,20 @@ function OPERATION:GetPhaseActive()
|
||||
return self.phase
|
||||
end
|
||||
|
||||
--- Check if a phase is the currently active one.
|
||||
-- @param #OPERATION self
|
||||
-- @param #OPERATION.Phase Phase The phase to check.
|
||||
-- @return #boolean If `true`, this phase is currently active.
|
||||
function OPERATION:IsPhaseActive(Phase)
|
||||
local phase=self:GetPhaseActive()
|
||||
if phase and phase.uid==Phase.uid then
|
||||
return true
|
||||
else
|
||||
return false
|
||||
end
|
||||
return nil
|
||||
end
|
||||
|
||||
--- Get next phase.
|
||||
-- @param #OPERATION self
|
||||
-- @return #OPERATION.Phase Next phase or `nil` if no next phase exists.
|
||||
@@ -280,7 +482,7 @@ function OPERATION:GetPhaseNext()
|
||||
for _,_phase in pairs(self.phases or {}) do
|
||||
local phase=_phase --#OPERATION.Phase
|
||||
|
||||
if not phase.isOver then
|
||||
if phase.status==OPERATION.PhaseStatus.PLANNED then
|
||||
-- Return first phase that is not over.
|
||||
return phase
|
||||
end
|
||||
@@ -292,17 +494,52 @@ end
|
||||
|
||||
--- Count phases.
|
||||
-- @param #OPERATION self
|
||||
-- @param #string Status (Optional) Only count phases in a certain status, e.g. `OPERATION.PhaseStatus.PLANNED`.
|
||||
-- @return #number Number of phases
|
||||
function OPERATION:CountPhases()
|
||||
function OPERATION:CountPhases(Status)
|
||||
|
||||
local N=0
|
||||
for phasename, phase in pairs(self.phases) do
|
||||
N=N+1
|
||||
for _,_phase in pairs(self.phases) do
|
||||
local phase=_phase --#OPERATION.Phase
|
||||
if Status==nil or Status==phase.status then
|
||||
N=N+1
|
||||
end
|
||||
end
|
||||
|
||||
return N
|
||||
end
|
||||
|
||||
--- Check if operation is in FSM state "Planned".
|
||||
-- @param #OPERATION self
|
||||
-- @return #boolean If `true`, operation is "Planned".
|
||||
function OPERATION:IsPlanned()
|
||||
local is=self:is("Planned")
|
||||
return is
|
||||
end
|
||||
|
||||
--- Check if operation is in FSM state "Running".
|
||||
-- @param #OPERATION self
|
||||
-- @return #boolean If `true`, operation is "Running".
|
||||
function OPERATION:IsRunning()
|
||||
local is=self:is("Running")
|
||||
return is
|
||||
end
|
||||
|
||||
--- Check if operation is in FSM state "Paused".
|
||||
-- @param #OPERATION self
|
||||
-- @return #boolean If `true`, operation is "Paused".
|
||||
function OPERATION:IsPaused()
|
||||
local is=self:is("Paused")
|
||||
return is
|
||||
end
|
||||
|
||||
--- Check if operation is in FSM state "Stopped".
|
||||
-- @param #OPERATION self
|
||||
-- @return #boolean If `true`, operation is "Stopped".
|
||||
function OPERATION:IsStopped()
|
||||
local is=self:is("Stopped")
|
||||
return is
|
||||
end
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
-- Status Update
|
||||
@@ -315,12 +552,8 @@ end
|
||||
-- @param #string To To state.
|
||||
function OPERATION:onafterStart(From, Event, To)
|
||||
|
||||
-- Get
|
||||
local Phase=self:GetPhaseNext()
|
||||
|
||||
if Phase then
|
||||
self:PhaseChange(Phase)
|
||||
end
|
||||
-- Debug message.
|
||||
self:T(self.lid..string.format("Starting Operation!"))
|
||||
|
||||
end
|
||||
|
||||
@@ -338,22 +571,34 @@ function OPERATION:onafterStatusUpdate(From, Event, To)
|
||||
-- Current FSM state.
|
||||
local fsmstate=self:GetState()
|
||||
|
||||
-- Check phases.
|
||||
if self:IsRunning() then
|
||||
self:_CheckPhases()
|
||||
end
|
||||
|
||||
-- Current phase.
|
||||
local currphase=self:GetPhaseActive()
|
||||
local phasename=currphase and currphase.name or "None"
|
||||
local Nphase=self:CountPhases()
|
||||
local phaseName="None"
|
||||
if currphase then
|
||||
phaseName=currphase.name
|
||||
end
|
||||
local NphaseTot=self:CountPhases()
|
||||
local NphaseAct=self:CountPhases(OPERATION.PhaseStatus.ACTIVE)
|
||||
local NphasePla=self:CountPhases(OPERATION.PhaseStatus.PLANNED)
|
||||
local NphaseOvr=self:CountPhases(OPERATION.PhaseStatus.OVER)
|
||||
|
||||
-- General info.
|
||||
local text=string.format("State=%s: Phase=%s, Phases=%d", fsmstate, phasename, Nphase)
|
||||
local text=string.format("State=%s: Phase=%s, Phases=%d [Active=%d, Planned=%d, Over=%d]", fsmstate, phaseName, NphaseTot, NphaseAct, NphasePla, NphaseOvr)
|
||||
self:I(self.lid..text)
|
||||
|
||||
-- Info on phases.
|
||||
local text="Phases:"
|
||||
for i,_phase in pairs(self.phases) do
|
||||
local phase=_phase --#OPERATION.Phase
|
||||
text=text..string.format("\n[%d] %s", i, phase.name)
|
||||
text=text..string.format("\n[%d] %s: status=%s", i, phase.name, tostring(phase.status))
|
||||
end
|
||||
if text=="Phases:" then text=text.." None" end
|
||||
self:I(self.lid..text)
|
||||
|
||||
-- Next status update.
|
||||
self:__StatusUpdate(-30)
|
||||
@@ -363,20 +608,30 @@ end
|
||||
-- FSM Functions
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
--- On after "ChangePhase" event.
|
||||
--- On after "PhaseChange" event.
|
||||
-- @param #OPERATION self
|
||||
-- @param #string From From state.
|
||||
-- @param #string Event Event.
|
||||
-- @param #string To To state.
|
||||
-- @param #OPERATION.Phase Phase The new phase.
|
||||
function OPERATION:onafterChangePhase(From, Event, To, Phase)
|
||||
function OPERATION:onafterPhaseChange(From, Event, To, Phase)
|
||||
|
||||
-- Previous phase (if any).
|
||||
local oldphase="None"
|
||||
if self.phase then
|
||||
self:SetPhaseStatus(self.phase, OPERATION.PhaseStatus.OVER)
|
||||
oldphase=self.phase.name
|
||||
end
|
||||
|
||||
-- Debug message.
|
||||
self:T(self.lid..string.format("Changed to phase: %s", Phase.name))
|
||||
self:T(self.lid..string.format("Phase change: %s --> %s", oldphase, Phase.name))
|
||||
|
||||
-- Set currently active phase.
|
||||
self.phase=Phase
|
||||
|
||||
-- Phase is active.
|
||||
self:SetPhaseStatus(Phase, OPERATION.PhaseStatus.ACTIVE)
|
||||
|
||||
end
|
||||
|
||||
--- On after "Over" event.
|
||||
@@ -389,7 +644,16 @@ function OPERATION:onafterOver(From, Event, To)
|
||||
|
||||
-- Debug message.
|
||||
self:T(self.lid..string.format("Operation is over!"))
|
||||
|
||||
|
||||
-- No active phase.
|
||||
self.phase=nil
|
||||
|
||||
-- Set all phases to OVER.
|
||||
for _,_phase in pairs(self.phases) do
|
||||
local phase=_phase --#OPERATION.Phase
|
||||
self:SetPhaseStatus(phase, OPERATION.PhaseStatus.OVER)
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
@@ -403,13 +667,16 @@ function OPERATION:_CheckPhases()
|
||||
-- Currently active phase.
|
||||
local phase=self:GetPhaseActive()
|
||||
|
||||
-- Check if active phase is over.
|
||||
if phase then
|
||||
phase.isOver=phase.conditionOver:Evaluate()
|
||||
-- Check if active phase is over if conditon over is defined.
|
||||
if phase and phase.conditionOver then
|
||||
local isOver=phase.conditionOver:Evaluate()
|
||||
if isOver then
|
||||
self:SetPhaseStatus(phase, OPERATION.PhaseStatus.OVER)
|
||||
end
|
||||
end
|
||||
|
||||
-- If no current phase or current phase is over, get next phase.
|
||||
if phase==nil or (phase and phase.isOver) then
|
||||
if phase==nil or phase.status==OPERATION.PhaseStatus.OVER then
|
||||
|
||||
-- Get next phase.
|
||||
local Phase=self:GetPhaseNext()
|
||||
@@ -423,6 +690,7 @@ function OPERATION:_CheckPhases()
|
||||
|
||||
-- No further phases defined ==> Operation is over.
|
||||
self:Over()
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user