Last Updates

Moose Development/Moose/Wrapper/Airbase.lua

@@ -0,0 +1,109 @@
+--- This module contains the AIRBASE classes.
+-- 
+-- ===
+-- 
+-- 1) @{Airbase#AIRBASE} class, extends @{Positionable#POSITIONABLE}
+-- =================================================================
+-- The @{AIRBASE} class is a wrapper class to handle the DCS Airbase objects:
+-- 
+--  * Support all DCS Airbase APIs.
+--  * Enhance with Airbase specific APIs not in the DCS Airbase API set.
+--  
+--  
+-- 1.1) AIRBASE reference methods
+-- ------------------------------ 
+-- For each DCS Airbase object alive within a running mission, a AIRBASE wrapper object (instance) will be created within the _@{DATABASE} object.
+-- This is done at the beginning of the mission (when the mission starts).
+--  
+-- The AIRBASE class **does not contain a :New()** method, rather it provides **:Find()** methods to retrieve the object reference
+-- using the DCS Airbase or the DCS AirbaseName.
+-- 
+-- Another thing to know is that AIRBASE objects do not "contain" the DCS Airbase object. 
+-- The AIRBASE methods will reference the DCS Airbase object by name when it is needed during API execution.
+-- If the DCS Airbase object does not exist or is nil, the AIRBASE methods will return nil and log an exception in the DCS.log file.
+--  
+-- The AIRBASE class provides the following functions to retrieve quickly the relevant AIRBASE instance:
+-- 
+--  * @{#AIRBASE.Find}(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase object.
+--  * @{#AIRBASE.FindByName}(): Find a AIRBASE instance from the _DATABASE object using a DCS Airbase name.
+--  
+-- IMPORTANT: ONE SHOULD NEVER SANATIZE these AIRBASE OBJECT REFERENCES! (make the AIRBASE object references nil).
+-- 
+-- 1.2) DCS AIRBASE APIs
+-- ---------------------
+-- The DCS Airbase APIs are used extensively within MOOSE. The AIRBASE class has for each DCS Airbase API a corresponding method.
+-- To be able to distinguish easily in your code the difference between a AIRBASE API call and a DCS Airbase API call,
+-- the first letter of the method is also capitalized. So, by example, the DCS Airbase method @{DCSAirbase#Airbase.getName}()
+-- is implemented in the AIRBASE class as @{#AIRBASE.GetName}().
+-- 
+-- More functions will be added
+-- ----------------------------
+-- During the MOOSE development, more functions will be added. 
+-- 
+-- @module Airbase
+-- @author FlightControl
+
+
+
+
+
+--- The AIRBASE class
+-- @type AIRBASE
+-- @extends Positionable#POSITIONABLE
+AIRBASE = {
+  ClassName="AIRBASE",
+  CategoryName = { 
+    [Airbase.Category.AIRDROME]   = "Airdrome",
+    [Airbase.Category.HELIPAD]    = "Helipad",
+    [Airbase.Category.SHIP]       = "Ship",
+    },
+  }
+
+-- Registration.
+  
+--- Create a new AIRBASE from DCSAirbase.
+-- @param #AIRBASE self
+-- @param #string AirbaseName The name of the airbase.
+-- @return Airbase#AIRBASE
+function AIRBASE:Register( AirbaseName )
+
+  local self = BASE:Inherit( self, POSITIONABLE:New( AirbaseName ) )
+  self.AirbaseName = AirbaseName
+  return self
+end
+
+-- Reference methods.
+
+--- Finds a AIRBASE from the _DATABASE using a DCSAirbase object.
+-- @param #AIRBASE self
+-- @param DCSAirbase#Airbase DCSAirbase An existing DCS Airbase object reference.
+-- @return Airbase#AIRBASE self
+function AIRBASE:Find( DCSAirbase )
+
+  local AirbaseName = DCSAirbase:getName()
+  local AirbaseFound = _DATABASE:FindAirbase( AirbaseName )
+  return AirbaseFound
+end
+
+--- Find a AIRBASE in the _DATABASE using the name of an existing DCS Airbase.
+-- @param #AIRBASE self
+-- @param #string AirbaseName The Airbase Name.
+-- @return Airbase#AIRBASE self
+function AIRBASE:FindByName( AirbaseName )
+  
+  local AirbaseFound = _DATABASE:FindAirbase( AirbaseName )
+  return AirbaseFound
+end
+
+function AIRBASE:GetDCSObject()
+  local DCSAirbase = Airbase.getByName( self.AirbaseName )
+  
+  if DCSAirbase then
+    return DCSAirbase
+  end
+    
+  return nil
+end
+
+
+