Included route validation changes

Courtesy of @FreshDave29

Author: MorpheusXAUT

DelHel/CDelHel.cpp

@@ -31,6 +31,7 @@ CDelHel::CDelHel() : EuroScopePlugIn::CPlugIn(
 	this->LoadSettings();
 
 	this->ReadAirportConfig();
+	this->ReadRoutingConfig();
 
 	if (this->updateCheck) {
 		this->latestVersion = std::async(FetchLatestVersion);
@@ -114,6 +115,7 @@ bool CDelHel::OnCompileCommand(const char* sCommandLine)
 
 			this->airports.clear();
 			this->ReadAirportConfig();
+			this->ReadRoutingConfig();
 
 			return true;
 		}
@@ -248,6 +250,66 @@ void CDelHel::SaveSettings()
 	this->SaveDataToSettings(PLUGIN_NAME, "DelHel settings", ss.str().c_str());
 }
 
+void CDelHel::ReadRoutingConfig()
+{
+	json j;
+
+	try {
+		std::filesystem::path base2(GetPluginDirectory());
+		base2.append("routing.json");
+
+		std::ifstream ifs(base2.c_str());
+
+		j = json::parse(ifs);
+	}
+	catch (std::exception e)
+	{
+		this->LogMessage("Failed to read routing config. Error: " + std::string(e.what()), "Config");
+		return;
+	}
+
+	for (auto itair = this->airports.begin(); itair != this->airports.end(); itair++) {
+
+		for (auto& obj : j.items()) {		//iterator on outer json object -> key = departure icao
+			if (obj.key() == itair->second.icao) {	//if departure icao has already been read in by AirportConfig
+
+				try {
+					for (auto& el : obj.value()["entry"].items()) {	//iterator on routes items
+
+						for (auto& in_el : el.value()["routes"].items()) {
+
+							routing ro{
+								obj.key(),
+								in_el.value()["icao"],
+								in_el.value()["maxlvl"],
+								in_el.value()["minlvl"],
+								{}
+							};
+
+							ro.waypts.push_back(el.value()["name"]);	// add entry-point = SID exit as first waypoint of route
+
+							for (auto& inner_el : in_el.value()["waypoints"].items()) {	// add route waypoints
+								ro.waypts.push_back(inner_el.value());
+							}
+
+							itair->second.validroutes.push_back(ro);	//add routing to airports
+
+							std::string check = "ADEP:" + ro.adep + "-ADEST:" + ro.adest + "-MAX:" + std::to_string(ro.maxlvl) + "-MIN:" + std::to_string(ro.minlvl) + "-#wpts:" + std::to_string(ro.waypts.size());
+							this->LogDebugMessage("New Routing added: " + check, "Config");
+						}
+					}
+				}
+				catch (std::exception e) {
+					this->LogMessage("Failed to read routing config for " + itair->second.icao + "| Error: " + std::string(e.what()), "Config");
+					return;
+				}
+				this->LogDebugMessage("Routing for departure Airport " + itair->second.icao + " has been added.", "Config");
+			}
+
+		}
+	}
+}
+
 void CDelHel::ReadAirportConfig()
 {
 	json j;
@@ -322,6 +384,7 @@ void CDelHel::ReadAirportConfig()
 	}
 }
 
+
 validation CDelHel::ProcessFlightPlan(const EuroScopePlugIn::CFlightPlan& fp, bool nap, bool validateOnly)
 {
 	validation res{
@@ -514,13 +577,129 @@ validation CDelHel::ProcessFlightPlan(const EuroScopePlugIn::CFlightPlan& fp, bo
 		this->IsFlightPlanProcessed(fp);
 	}
 
+
+	if (ap.validroutes.size() != 0) {
+
+		flightplan fpl = flightplan(fp.GetCallsign(), fp.GetExtractedRoute(), fpd.GetRoute()); // create fp for route validation
+
+		bool routecheck = false;
+		for (auto vait = ap.validroutes.begin(); vait != ap.validroutes.end(); ++vait) {
+
+			routecheck = false;
+			auto selsidit = vait->waypts.begin();
+
+			if (*selsidit == sid.wp) {
+				if (vait->waypts.size() > 1) {
+					try {
+
+						auto wyprouit = vait->waypts.begin();
+
+						for (auto wypfpl = fpl.route.begin(); wypfpl != fpl.route.end(); ++wypfpl) {
+
+							if (wypfpl->name == *wyprouit) {
+								routecheck = true;
+
+								if (wyprouit == vait->waypts.end() - 1) {
+									break;
+								}
+								else {
+									++wyprouit;
+								}
+							}
+							else {
+								routecheck = false;
+							}
+						}
+
+					}
+					catch (std::exception e) {
+						this->LogDebugMessage("Error, No Routing", cs);
+					}
+				}
+				else {
+					routecheck = true;
+				}
+				if (routecheck && vait->adest == arr) { //check specified destinations like LOWI, LOWS, etc.
+
+					if ((cad.GetFinalAltitude() == 0 && fpd.GetFinalAltitude() > vait->maxlvl * 100) || cad.GetFinalAltitude() > vait->maxlvl * 100) {
+
+						res.valid = false;
+						res.tag = "MAX";
+						res.color = TAG_COLOR_ORANGE;
+						return res;
+					}
+					if ((cad.GetFinalAltitude() == 0 && fpd.GetFinalAltitude() < vait->minlvl * 100) || (cad.GetFinalAltitude() != 0 && cad.GetFinalAltitude() < vait->minlvl * 100)) {
+
+						res.valid = false;
+						res.tag = "MIN";
+						res.color = TAG_COLOR_ORANGE;
+						return res;
+					}
+
+					//case all correct
+					res.valid = true;
+					res.tag = "";
+					res.color = TAG_COLOR_NONE;
+
+					return res;
+
+				}
+				else if (routecheck && vait->adest != arr && vait->adest == "") { // check for non specified destinations
+					if ((cad.GetFinalAltitude() == 0 && fpd.GetFinalAltitude() > vait->maxlvl * 100) || cad.GetFinalAltitude() > vait->maxlvl * 100) {
+
+						res.valid = false;
+						res.tag = "MAX";
+						res.color = TAG_COLOR_ORANGE;
+						break;
+					}
+					if ((cad.GetFinalAltitude() == 0 && fpd.GetFinalAltitude() < vait->minlvl * 100) || (cad.GetFinalAltitude() != 0 && cad.GetFinalAltitude() < vait->minlvl * 100)) {
+
+						res.valid = false;
+						res.tag = "MIN";
+						res.color = TAG_COLOR_ORANGE;
+						break;
+					}
+
+					//case all correct
+					res.valid = true;
+					res.tag = "";
+					res.color = TAG_COLOR_NONE;
+
+					return res;
+
+				}
+				else if (this->CheckFlightPlanProcessed(fp)) {
+					res.valid = false;
+					res.tag = "INV";
+					res.color = TAG_COLOR_ORANGE;
+					continue;
+				}
+				else {
+					res.valid = false;
+					res.tag = "";
+					res.color = TAG_COLOR_NONE;
+					continue;
+				}
+			}
+		}
+	}
 	return res;
 }
 
+bool CDelHel::CheckFlightPlanProcessed(const EuroScopePlugIn::CFlightPlan& fp)
+{
+	std::string cs = fp.GetCallsign();
+
+	if (std::find(this->processed.begin(), this->processed.end(), cs) != this->processed.end()) {
+		return true;
+	}
+	return false;
+}
+
 bool CDelHel::IsFlightPlanProcessed(const EuroScopePlugIn::CFlightPlan& fp)
 {
 	std::string cs = fp.GetCallsign();
-	
+
 	if (std::find(this->processed.begin(), this->processed.end(), cs) != this->processed.end()) {
 		return true;
 	}

DelHel/CDelHel.h

@@ -18,6 +18,7 @@
 #include "airport.h"
 #include "validation.h"
 #include "flightplan.h"
+#include "sid.h"
 
 using json = nlohmann::json;
 using namespace std::chrono_literals;
@@ -45,9 +46,11 @@ class CDelHel : public EuroScopePlugIn::CPlugIn
 
 	void LoadSettings();
 	void SaveSettings();
+	void ReadRoutingConfig();
 	void ReadAirportConfig();
 
 	validation ProcessFlightPlan(const EuroScopePlugIn::CFlightPlan& fp, bool nap, bool validateOnly = false);
+	bool CDelHel::CheckFlightPlanProcessed(const EuroScopePlugIn::CFlightPlan& fp);
 	bool IsFlightPlanProcessed(const EuroScopePlugIn::CFlightPlan& fp);
 	void AutoProcessFlightPlans();
 

DelHel/DelHel.vcxproj

@@ -218,6 +218,9 @@
     <CopyFileToFolders Include="..\airports.json">
       <FileType>Document</FileType>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="..\routing.json">
+      <FileType>Document</FileType>
+    </CopyFileToFolders>
     <None Include="DelHel.def" />
     <None Include="res\DelHel.rc2" />
   </ItemGroup>
@@ -231,6 +234,7 @@
     <ClInclude Include="pch.h" />
     <ClInclude Include="Resource.h" />
     <ClInclude Include="route_entry.h" />
+    <ClInclude Include="routing.h" />
     <ClInclude Include="sid.h" />
     <ClInclude Include="targetver.h" />
     <ClInclude Include="helpers.h" />

DelHel/DelHel.vcxproj.filters

@@ -82,6 +82,9 @@
     <ClInclude Include="route_entry.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="routing.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="DelHel.rc">
@@ -97,5 +100,8 @@
     <CopyFileToFolders Include="..\airports.json">
       <Filter>Resource Files</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="..\routing.json">
+      <Filter>Resource Files</Filter>
+    </CopyFileToFolders>
   </ItemGroup>
 </Project>

DelHel/airport.h

@@ -6,11 +6,13 @@
 #include <regex>
 
 #include "sid.h"
+#include "routing.h"
 
 struct airport {
 	std::string icao;
 	int elevation;
 	std::map<std::string, sid> sids;
 	std::set<std::string> rwys;
+	std::vector<routing> validroutes;
 	std::regex rwy_regex;
 };

DelHel/routing.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <string>
+#include <vector>
+#include "route_entry.h"
+
+struct routing {
+	std::string adep;
+	std::string adest;
+	int maxlvl{};
+	int minlvl{};
+	std::vector<std::string> waypts;
+};

README.md

@@ -54,6 +54,7 @@ At the moment, `DelHel` supports the following validations and processing:
 - CFL (**c**leared **f**light **l**evel) validation: verifies correct CFL is set for selected SID. Processing a FPL automatically sets the correct CFL for the calculated SID.
 - RWY (**r**un**w**a**y**) validation: displays a warning if a runway assignment has been found in the flightplan as this might influence SID selection.
 - Flightplan cleanup: when processing a flightplan, some cleanup will be performed, removing any additional information the pilot might have included before the SID fix (e.g. a SID filed by the pilot), only leaving a valid speed/level group or a runway designation included. This prevents SID assignments filed by pilots from selecting an incorrect runway or procedure by accident.
+- INV (**Inv**alid routing): verifies that the filed flightplan contains a valid routing according to the maintained routing.json file. Those routes can e.g. be the SAXFRA compulsory routings or special Vatsim Event routings. Each route contains at least an entry point (= last waypoint of the SID) and optional waypoints. If waypoints are maintained, the flightplan has to contain those waypoints in identical sequence in order to pass the routing validation. "DCT"/"DIRECT"/Speed-Altitude-Blocks in the FP are omitted.
 
 Flightplans can be processed manually using the [`Process FPL`](#process-fpl) [tag function](#tag-functions) or automatically by toggling the [automatic processing](#toggle-automatic-processing) setting on.
 
@@ -103,6 +104,25 @@ Indicates pilot filed a VFR flightplan, so little to no validations can be perfo
 Info, green color.  
 Indicates pilot filed a processed VFR flightplan, so little to no validations can be performed. This just serves as an additional reminder about VFR flights.
 
+##### `MIN`
+
+Caution, orange color.
+Indicates, that the Requested Flight Level RFL is below the minima for the filed route. 
+The altitudes are maintained in the routing.json and can be disregarded by the controller if necessary (e.g. depeding on active/inactive military areas along the route).
+
+##### `MAX`
+
+Caution, orange color.
+Indicates, that the Requested Flight Level RFL is above the maxima for the filed route. 
+The altitudes are maintained in the routing.json and can be disregarded by the controller if necessary (e.g. depeding on active/inactive military areas along the route).
+
+
+##### `INV`
+
+Caution, orange color.
+Indicates, that the filed route is not valid according to the maintained routings (routing.json). Those routings are e.g. the compulsory SAXRFRA routings for LOWW-departures or in case of a Vatsim Event.
+Indication becomes active as soon as the flightplan has been processed (SID is set and a valid SID exit point is in the FP).
+
 ##### `OK`
 
 Info, green color.  

airports.json

@@ -460,7 +460,7 @@
     }
   },
   "LOWL": {
-    "elevation":  980,
+    "elevation": 980,
     "sids": {
       "LIDSI": {
         "cfl": 6000,