Navigation

2025-10-29 16:58:06 +00:00 · 2023-10-08 21:49:15 +02:00
parent 1ece7238dc
commit 4e24a7bf80
9 changed files with 524 additions and 32 deletions
--- a/Development/Moose/Navigation/FlightPlan.lua
+++ b/Development/Moose/Navigation/FlightPlan.lua
@@ -25,11 +25,12 @@
 -- @field #string ClassName Name of the class.
 -- @field #number verbose Verbosity of output.
 -- @field #table fixes Navigation fixes.
+-- @field Core.Pathline#PATHLINE pathline Pathline of the plan.
 -- @field Wrapper.Airbase#AIRBASE departureAirbase Departure airbase.
 -- @field Wrapper.Airbase#AIRBASE destinationAirbase Destination airbase.
 -- @field #number altitudeCruiseMin Minimum cruise altitude in feet MSL.
 -- @field #number altitudeCruiseMax Maximum cruise altitude in feet MSL.
-- @extends Core.Base#BASE
+-- @extends Core.Pathline#PATHLINE

 --- *Life is what happens to us while we are making other plans.* -- Allen Saunders
 --
@@ -37,12 +38,11 @@
 --
 -- # The FLIGHTPLAN Concept
 --
-- A FLIGHTPLAN consists of one or multiple FLOTILLAs. These flotillas "live" in a WAREHOUSE that has a phyiscal struction (STATIC or UNIT) and can be captured or destroyed.
+-- This class has a great concept!
 -- 
 -- # Basic Setup
 -- 
-- A new `FLIGHTPLAN` object can be created with the @{#FLIGHTPLAN.New}(`WarehouseName`, `FleetName`) function, where `WarehouseName` is the name of the static or unit object hosting the fleet
-- and `FleetName` is the name you want to give the fleet. This must be *unique*!
+-- A new `FLIGHTPLAN` object can be created with the @{#FLIGHTPLAN.New}() function.
 -- 
 --     myFlightplan=FLIGHTPLAN:New("Plan A")
 --     myFleet:SetPortZone(ZonePort1stFleet)
@@ -81,8 +81,10 @@ FLIGHTPLAN.version="0.0.1"
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

 -- TODO: How to connect SID, STAR, ENROUTE, TRANSITION, APPROACH. Typical flightplan SID --> ENROUTE --> STAR --> APPROACH
-- TODO: How to handle the FLIGHTGROUP:_LandAtAirBase
+-- TODO: Add approach.
+-- DONE: How to handle the FLIGHTGROUP:_LandAtAirBase
 -- TODO: Do we always need a holding pattern? https://www.faa.gov/air_traffic/publications/atpubs/aip_html/part2_enr_section_1.5.html#:~:text=If%20no%20holding%20pattern%20is,than%20that%20desired%20by%20ATC.
+-- DOEN: Read from MSFS file.

 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor
@@ -94,8 +96,8 @@ FLIGHTPLAN.version="0.0.1"
 -- @return #FLIGHTPLAN self
 function FLIGHTPLAN:New(Name)

-  -- Inherit everything from SCENERY class.
-  self=BASE:Inherit(self, BASE:New()) -- #FLIGHTPLAN
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, PATHLINE:New(Name)) -- #FLIGHTPLAN

  -- Set alias.
  self.alias=tostring(Name)
@@ -103,6 +105,8 @@ function FLIGHTPLAN:New(Name)
  -- Set some string id for output to DCS.log file.
  self.lid=string.format("FLIGHTPLAN %s | ", self.alias)
  
+  --self.pathline=PATHLINE:New(Name)
+  
  -- Debug info.
  self:I(self.lid..string.format("Created FLIGHTPLAN!"))

@@ -119,30 +123,55 @@ function FLIGHTPLAN:NewFromFlightPlan(FlightPlan)
  return self
 end

+
+--- Create a new FLIGHTPLAN instance from a given file.
+-- Currently, the file has to be an MSFS 2020 .pln file as, *e.g.*, exported from [Navigraph](https://navigraph.com/).
+-- 
+-- **Note** that the flight plan does only cover the departure, enroute and arrival portions but **not the approach** part!
+-- @param #FLIGHTPLAN self
+-- @param #string FileName Full path to file.
+-- @return #FLIGHTPLAN self
+function FLIGHTPLAN:NewFromFile(FileName)
+
+  if UTILS.FileExists(FileName) then
+  
+    self=FLIGHTPLAN._ReadFileMSFS(FileName)  
+  
+  else
+    error(string.format("ERROR: File not found! File name=%s", tostring(FileName)))  
+  end
+
+  return self
+end
+
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- User Functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

 --- Add navigation fix to the flight plan.
 -- @param #FLIGHTPLAN self
-- @param Navigation.NavFix#NAVFIX NavFix The nav fix.
+-- @param Navigation.Point#NAVPOINT NavFix The nav fix.
 -- @return #FLIGHTPLAN self
 function FLIGHTPLAN:AddNavFix(NavFix)

  table.insert(self.fixes, NavFix)
+  
+  local point=self:AddPointFromVec3(NavFix.vector:GetVec3(true))
+  
+  point.navpoint=NavFix

  return self
 end


--- Set depature airbase.
+--- Set departure airbase.
 -- @param #FLIGHTPLAN self
 -- @param #string AirbaseName Name of the airbase or AIRBASE object.
 -- @return #FLIGHTPLAN self
 function FLIGHTPLAN:SetDepartureAirbase(AirbaseName)

  self.departureAirbase=AIRBASE:FindByName(AirbaseName)
-
+ 
  return self
 end

@@ -171,6 +200,19 @@ function FLIGHTPLAN:SetCruiseAltitude(AltMin, AltMax)
  return self
 end

+--- Set cruise speed.
+-- @param #FLIGHTPLAN self
+-- @param #number SpeedMin Minimum speed in knots.
+-- @param #number SpeedMax Maximum speed in knots. Default is `SpeedMin`.
+-- @return #FLIGHTPLAN self
+function FLIGHTPLAN:SetCruiseSpeed(SpeedMin, SpeedMax)
+
+  self.speedCruiseMin=SpeedMin
+  self.speedCruiseMax=SpeedMax or self.speedCruiseMin
+
+  return self
+end
+

 --- Get the name of this flight plan.
 -- @param #FLIGHTPLAN self
@@ -197,11 +239,242 @@ function FLIGHTPLAN:GetCruiseAltitude()
  return alt
 end

+--- Get cruise speed. This returns a random speed between the set min/max cruise speeds.
+-- @param #FLIGHTPLAN self
+-- @return #number Cruise speed in knots.
+function FLIGHTPLAN:GetCruiseSpeed()
+
+  local speed=250
+  
+  if self.speedCruiseMin and self.speedCruiseMax then
+    speed=math.random(self.speedCruiseMin, self.speedCruiseMax)
+  elseif self.speedCruiseMin then
+    speed=self.speedCruiseMin
+  elseif self.altitudeCruiseMax then
+    speed=self.speedCruiseMax
+  end
+  
+  return speed
+end
+
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Private Functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

-- No private functions yet.
+--- Read flight plan from a given MSFS 2020 .plt file.
+-- @param #string FileName Name of the file.
+-- @return #FLIGHTPLAN The flight plan.
+function FLIGHTPLAN._ReadFileMSFS(FileName)
+
+  local function readfile(filename)
+
+    local lines = {}
+    
+    -- Open file in read binary mode.
+    local file=assert(io.open(filename, "rb"), string.format("File not found! File name = %s", tostring(filename)))
+
+    for line in file:lines() do
+        lines[#lines+1] = line
+    end
+    
+    -- Close file.
+    file:close()
+  
+    -- Return data
+    return lines
+  end
+
+
+  --- This function returns an XML element, i.e. the string between <...> and </...>.
+  local function getXMLelement(line)
+    local element=string.match(line, ">(.+)<")
+    return element
+  end
+
+  --- This function returns Latitude and Longitude
+  local function getLatLong(line)
+    local latlong=getXMLelement(line)
+    -- The format is "N41° 38' 20.00",E41° 33' 19.00",+000000.00" so we still need to process that.
+    local lat,long=string.match(latlong, "(.+),(.+),")
+    return lat,long
+  end
+  
+  -- Read data from file.
+  local data=readfile(FileName)
+
+  local flightplan={}
+  local waypoints={}
+  local wp=nil
+  
+  local gotwaypoint=false
+  for i,line in pairs(data) do
+  
+  
+    --print(line)
+  
+    -- Title  
+    if string.find(line, "<Title>") then
+      flightplan.title=getXMLelement(line)
+    end
+  
+    -- Departure ICAO
+    if string.find(line, "<DepartureID>") then
+      flightplan.departureICAO=getXMLelement(line)
+    end
+  
+    -- Destination ICAO
+    if string.find(line, "<DestinationID>") then
+      flightplan.destinationICAO=getXMLelement(line)
+    end
+  
+    -- FPType  
+    if string.find(line, "<FPType>") then
+      flightplan.plantype=getXMLelement(line)
+    end
+    
+    -- Route type  
+    if string.find(line, "<RouteType>") then
+      flightplan.routetype=getXMLelement(line)
+    end
+  
+    -- Cruise alt in feet
+    if string.find(line, "<CruisingAlt>") then
+      flightplan.altCruise=getXMLelement(line)
+    end
+  
+    -- Departure LLA
+    if string.find(line, "<DepartureLLA>") then
+      local lat,long=getLatLong(line)    
+    end
+    
+    -- Destination LLA
+    if string.find(line, "<DestinationLLA>") then
+      local lat,long=getLatLong(line)    
+    end  
+  
+    -- Departure Name
+    if string.find(line, "<DepartureName>") then
+      local DepartureName=getXMLelement(line)
+    end
+      
+    -- DestinationName
+    if string.find(line, "<DestinationName>") then
+      local DestinationName=getXMLelement(line)
+    end
+      
+    ---
+    -- Waypoint stuff
+    ---
+  
+    -- New waypoint starts.
+    if string.find(line, "ATCWaypoint id") then
+    
+      --Get string inside quotes " and ". 
+      local wpid=string.match(line, [["(.+)"]]) 
+      
+      -- Create a new wp table.
+      wp={}
+      
+      -- Set waypoint name.
+      wp.name=wpid
+    end
+    
+    -- Waypoint info ends.
+    if string.find(line, "</ATCWaypoint>") then
+      -- This is the end of the waypoint.
+      
+      -- Add info to waypoints table.
+      table.insert(waypoints, wp)
+      
+      -- Set waypoint to nil. We create an empty table if the next wp starts.
+      wp=nil
+    end
+    
+    -- Waypoint type (Airport, Intersection, NDB, VORTAC)
+    if string.find(line, "<ATCWaypointType>") then
+      local wptype=getXMLelement(line)
+      wp.type=wptype
+    end
+    
+    -- Waypoint position.
+    if string.find(line, "<WorldPosition>") then
+      wp.lat, wp.long=getLatLong(line)
+    end
+    
+    -- Runway should exist for initial and final WP if it is an airport.
+    if string.find(line, "RunwayNumberFP") then
+      wp.runway=getXMLelement(line)
+    end
+    
+    -- Runway designator: LEFT, RIGHT, CENTER
+    if string.find(line, "RunwayDesignatorFP") then 
+      wp.runwayDesignator=getXMLelement(line)
+    end  
+    
+    -- Segment is Departure
+    if string.find(line, "<DepartureFP>") then
+      wp.segment="Departure"
+    end
+    
+    -- Segment is Arrival
+    if string.find(line, "<ArrivalFP>") then
+      wp.segment="Arrival"
+    end
+    
+    -- Segment is Enroute
+    if string.find(line, "<ATCAirway>") then
+      wp.segment="Enroute"
+    end
+  
+    -- Approach type: VORDME, LOCALIZER
+    if string.find(line, "ApproachTypeFP") then
+      flightplan.approachtype=getXMLelement(line)
+    end
+  
+    -- Approach type suffic: Z
+    if string.find(line, "SuffixFP") then
+      local SuffixFP=getXMLelement(line)
+    end
+    
+  end
+    
+  for key, value in pairs(flightplan) do
+    env.info(string.format("Flightplan %s=%s", key, tostring(value)))
+  end
+
+  env.info(string.format("Number of waypoints=%d", #waypoints))  
+  for i,wp in pairs(waypoints) do
+    env.info(string.format("Waypoint name=%s type=%s segment=%s runway=%s lat=%s long=%s", wp.name, wp.type, tostring(wp.segment), tostring(wp.runway)..tostring(wp.runwayDesignator or ""), wp.lat, wp.long))
+  end
+  
+  -- Create a new flightplan.
+  local fp=FLIGHTPLAN:New(flightplan.title)
+  
+  -- Set cruise altitude.
+  fp:SetCruiseAltitude(flightplan.altCruise)
+  
+  -- Set departure and destination airports.
+  fp:SetDepartureAirbase(flightplan.departureICAO)
+  fp:SetDestinationAirbase(flightplan.destinationICAO)
+  
+  --TODO: Remove first and last waypoint if they are identical to the departure/destination airport!
+  
+  for i,wp in pairs(waypoints) do
+      
+    -- Create a navpoint.
+    local navpoint=NAVPOINT:NewFromLLDMS(wp.name, wp.type, wp.lat, wp.long)
+    
+    navpoint:SetAltMin(flightplan.altCruise)
+  
+    -- Add point to flightplan.
+    -- TODO: section departure, enroute, arrival.
+    fp:AddNavFix(navpoint)  
+  end
+
+  
+
+  return fp
+end

 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------