mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
295 lines
8.8 KiB
Lua
295 lines
8.8 KiB
Lua
--- **Core** - Define any or all conditions to be evaluated.
|
|
--
|
|
-- **Main Features:**
|
|
--
|
|
-- * Add arbitrary numbers of conditon functions
|
|
-- * Evaluate *any* or *all* conditions
|
|
--
|
|
-- ===
|
|
--
|
|
-- ## Example Missions:
|
|
--
|
|
-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/OPS%20-%20Operation).
|
|
--
|
|
-- ===
|
|
--
|
|
-- ### Author: **funkyfranky**
|
|
--
|
|
-- ===
|
|
-- @module Core.Condition
|
|
-- @image Core_Conditon.png
|
|
|
|
--- CONDITON class.
|
|
-- @type CONDITION
|
|
-- @field #string ClassName Name of the class.
|
|
-- @field #string lid Class id string for output to DCS log file.
|
|
-- @field #boolean isAny General functions are evaluated as any condition.
|
|
-- @field #boolean negateResult Negeate result of evaluation.
|
|
-- @field #table functionsGen General condition functions.
|
|
-- @field #table functionsAny Any condition functions.
|
|
-- @field #table functionsAll All condition functions.
|
|
--
|
|
-- @extends Core.Base#BASE
|
|
|
|
--- *Better three hours too soon than a minute too late.* - William Shakespeare
|
|
--
|
|
-- ===
|
|
--
|
|
-- # The CONDITION Concept
|
|
--
|
|
--
|
|
--
|
|
-- @field #CONDITION
|
|
CONDITION = {
|
|
ClassName = "CONDITION",
|
|
lid = nil,
|
|
functionsGen = {},
|
|
functionsAny = {},
|
|
functionsAll = {},
|
|
}
|
|
|
|
--- Condition function.
|
|
-- @type CONDITION.Function
|
|
-- @field #function func Callback function to check for a condition. Should return a `#boolean`.
|
|
-- @field #table arg (Optional) Arguments passed to the condition callback function if any.
|
|
|
|
--- CONDITION class version.
|
|
-- @field #string version
|
|
CONDITION.version="0.1.0"
|
|
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
-- TODO list
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
-- TODO: Make FSM.
|
|
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
-- Constructor
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
--- Create a new CONDITION object.
|
|
-- @param #CONDITION self
|
|
-- @param #string Name (Optional) Name used in the logs.
|
|
-- @return #CONDITION self
|
|
function CONDITION:New(Name)
|
|
|
|
-- Inherit BASE.
|
|
local self=BASE:Inherit(self, BASE:New()) --#CONDITION
|
|
|
|
self.name=Name or "Condition X"
|
|
|
|
self.lid=string.format("%s | ", self.name)
|
|
|
|
return self
|
|
end
|
|
|
|
--- Set that general condition functions return `true` if `any` function returns `true`. Default is that *all* functions must return `true`.
|
|
-- @param #CONDITION self
|
|
-- @param #boolean Any If `true`, *any* condition can be true. Else *all* conditions must result `true`.
|
|
-- @return #CONDITION self
|
|
function CONDITION:SetAny(Any)
|
|
self.isAny=Any
|
|
return self
|
|
end
|
|
|
|
--- Negate result.
|
|
-- @param #CONDITION self
|
|
-- @param #boolean Negate If `true`, result is negated else not.
|
|
-- @return #CONDITION self
|
|
function CONDITION:SetNegateResult(Negate)
|
|
self.negateResult=Negate
|
|
return self
|
|
end
|
|
|
|
--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
|
|
-- @param #CONDITION self
|
|
-- @param #function Function The function to call.
|
|
-- @param ... (Optional) Parameters passed to the function (if any).
|
|
--
|
|
-- @usage
|
|
-- local function isAequalB(a, b)
|
|
-- return a==b
|
|
-- end
|
|
--
|
|
-- myCondition:AddFunction(isAequalB, a, b)
|
|
--
|
|
-- @return #CONDITION self
|
|
function CONDITION:AddFunction(Function, ...)
|
|
|
|
-- Condition function.
|
|
local condition=self:_CreateCondition(Function, ...)
|
|
|
|
-- Add to table.
|
|
table.insert(self.functionsGen, condition)
|
|
|
|
return self
|
|
end
|
|
|
|
--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
|
|
-- @param #CONDITION self
|
|
-- @param #function Function The function to call.
|
|
-- @param ... (Optional) Parameters passed to the function (if any).
|
|
-- @return #CONDITION self
|
|
function CONDITION:AddFunctionAny(Function, ...)
|
|
|
|
-- Condition function.
|
|
local condition=self:_CreateCondition(Function, ...)
|
|
|
|
-- Add to table.
|
|
table.insert(self.functionsAny, condition)
|
|
|
|
return self
|
|
end
|
|
|
|
--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
|
|
-- @param #CONDITION self
|
|
-- @param #function Function The function to call.
|
|
-- @param ... (Optional) Parameters passed to the function (if any).
|
|
-- @return #CONDITION self
|
|
function CONDITION:AddFunctionAll(Function, ...)
|
|
|
|
-- Condition function.
|
|
local condition=self:_CreateCondition(Function, ...)
|
|
|
|
-- Add to table.
|
|
table.insert(self.functionsAll, condition)
|
|
|
|
return self
|
|
end
|
|
|
|
|
|
--- Evaluate conditon functions.
|
|
-- @param #CONDITION self
|
|
-- @param #boolean AnyTrue If `true`, evaluation return `true` if *any* condition function returns `true`. By default, *all* condition functions must return true.
|
|
-- @return #boolean Result of condition functions.
|
|
function CONDITION:Evaluate(AnyTrue)
|
|
|
|
-- Check if at least one function was given.
|
|
if #self.functionsAll + #self.functionsAny + #self.functionsAll == 0 then
|
|
if self.negateResult then
|
|
return true
|
|
else
|
|
return false
|
|
end
|
|
end
|
|
|
|
-- Any condition for gen.
|
|
local evalAny=self.isAny
|
|
if AnyTrue~=nil then
|
|
evalAny=AnyTrue
|
|
end
|
|
|
|
local isGen=nil
|
|
if evalAny then
|
|
isGen=self:_EvalConditionsAny(self.functionsGen)
|
|
else
|
|
isGen=self:_EvalConditionsAll(self.functionsGen)
|
|
end
|
|
|
|
-- Is any?
|
|
local isAny=self:_EvalConditionsAny(self.functionsAny)
|
|
|
|
-- Is all?
|
|
local isAll=self:_EvalConditionsAll(self.functionsAll)
|
|
|
|
-- Result.
|
|
local result=isGen and isAny and isAll
|
|
|
|
-- Negate result.
|
|
if self.negateResult then
|
|
result=not result
|
|
end
|
|
|
|
-- Debug message.
|
|
self:T(self.lid..string.format("Evaluate: isGen=%s, isAny=%s, isAll=%s (negate=%s) ==> result=%s", tostring(isGen), tostring(isAny), tostring(isAll), tostring(self.negateResult), tostring(result)))
|
|
|
|
return result
|
|
end
|
|
|
|
--- Check if all given condition are true.
|
|
-- @param #CONDITION self
|
|
-- @param #table functions Functions to evaluate.
|
|
-- @return #boolean If true, all conditions were true (or functions was empty/nil). Returns false if at least one condition returned false.
|
|
function CONDITION:_EvalConditionsAll(functions)
|
|
|
|
-- At least one condition?
|
|
local gotone=false
|
|
|
|
|
|
-- Any stop condition must be true.
|
|
for _,_condition in pairs(functions or {}) do
|
|
local condition=_condition --#CONDITION.Function
|
|
|
|
-- At least one condition was defined.
|
|
gotone=true
|
|
|
|
-- Call function.
|
|
local istrue=condition.func(unpack(condition.arg))
|
|
|
|
-- Any false will return false.
|
|
if not istrue then
|
|
return false
|
|
end
|
|
|
|
end
|
|
|
|
-- All conditions were true.
|
|
return true
|
|
end
|
|
|
|
|
|
--- Check if any of the given conditions is true.
|
|
-- @param #CONDITION self
|
|
-- @param #table functions Functions to evaluate.
|
|
-- @return #boolean If true, at least one condition is true (or functions was emtpy/nil).
|
|
function CONDITION:_EvalConditionsAny(functions)
|
|
|
|
-- At least one condition?
|
|
local gotone=false
|
|
|
|
-- Any stop condition must be true.
|
|
for _,_condition in pairs(functions or {}) do
|
|
local condition=_condition --#CONDITION.Function
|
|
|
|
-- At least one condition was defined.
|
|
gotone=true
|
|
|
|
-- Call function.
|
|
local istrue=condition.func(unpack(condition.arg))
|
|
|
|
-- Any true will return true.
|
|
if istrue then
|
|
return true
|
|
end
|
|
|
|
end
|
|
|
|
-- No condition was true.
|
|
if gotone then
|
|
return false
|
|
else
|
|
-- No functions passed.
|
|
return true
|
|
end
|
|
end
|
|
|
|
--- Create conditon function object.
|
|
-- @param #CONDITION self
|
|
-- @param #function Function The function to call.
|
|
-- @param ... (Optional) Parameters passed to the function (if any).
|
|
-- @return #CONDITION.Function Condition function.
|
|
function CONDITION:_CreateCondition(Function, ...)
|
|
|
|
local condition={} --#CONDITION.Function
|
|
|
|
condition.func=Function
|
|
condition.arg={}
|
|
if arg then
|
|
condition.arg=arg
|
|
end
|
|
|
|
return condition
|
|
end
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
|
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |