tacticalenvModel API

There are 3 important services with specific data structures for the tacticalenvModel module:

• The http://dassault-aviation.com/tacticalenv:worldModel service which contains the FEBA, the targets, the threats, the bases, the zones, and the corridors
• The http://dassault-aviation.com/tacticalenv:aircraftsModel service which contains the aircrafts
• The http://dassault-aviation.com/tacticalenv:flightplansModel service which contains the flightplans
• The http://dassault-aviation.com/tacticalenv:waypointsModel service which contains the waypoints
• The http://dassault-aviation.com/tacticalenv:elements service which contains custom elements

WorldModel

The http://dassault-aviation.com/tacticalenv:worldModel service published by the tacticalenvModel module has the following specification:

      <event name="worldModel">
         <data name="feba" type="febaObject" />
         <data name="targets" type="targets" />
         <data name="zones" type="zones" />
         <data name="corridors" type="corridors" />
         <data name="bases" type="bases" />
         <data name="threats" type="threats" />
         <data name="elements" type="elements" />
      </event>

with the following types:

      <objectType name="febaObject" class="org.da.protoframework.tacticalenvmodel.model.FEBA" />
      <objectType name="targets" class="org.da.protoframework.tacticalenvmodel.model.Targets" />
      <objectType name="zones" class="org.da.protoframework.tacticalenvmodel.model.Zones" />
      <objectType name="corridors" class="org.da.protoframework.tacticalenvmodel.model.Corridors" />      
      <objectType name="bases" class="org.da.protoframework.tacticalenvmodel.model.Bases" />      
      <objectType name="threats" class="org.da.protoframework.tacticalenv.common.model.Threats" />      
      <objectType name="aircrafts" class="org.da.protoframework.tacticalenv.common.model.Aircrafts" />    
      <objectType name="flightplans" class="org.da.protoframework.tacticalenvmodel.model.Flightplans" />    
      <objectType name="waypoints" class="org.da.protoframework.tacticalenvmodel.model.Waypoints" />    
      <objectType name="elements" class="org.da.protoframework.tacticalenv.common.model.CustomElements" />

The associated API specifies 7 classes:

• "bases": The org.da.protoframework.tacticalenvmodel.model.Bases class
• "targets": The org.da.protoframework.tacticalenvmodel.model.Targets class
• "threats": The org.da.protoframework.tacticalenvmodel.model.Threats class
• "zones": The org.da.protoframework.tacticalenvmodel.model.Zones class
• "corridors": The org.da.protoframework.tacticalenvmodel.model.Corridors class
• "febaObject": The org.da.protoframework.tacticalenvmodel.model.FEBA class
• "aircrafts": The org.da.protoframework.tacticalenvmodel.model.Aircrafts class
• "flightplans": The org.da.protoframework.tacticalenvmodel.model.Flightplans class
• "waypoints": The org.da.protoframework.tacticalenvmodel.model.Waypoints class
• "elements": The org.da.protoframework.tacticalenvmodel.model.CustomElements class

FEBA class

The FEBA class has the following API:

      /**
      * Return true if the FEBA is empty.
      */
      public boolean isEmpty();

      /**
      * Return the FEBA list of points.
      */
      public List<Point> getPoints();

      /**
      * Add a point.
      */
      public void addPoint(Point point);

      /**
      * Count the number of points.
      */
      public int countPoints();

Targets class

The Targets class has the following API:

      /**
      * Return the map of targets.
      */
      public Map<String, Target> getTargets();

      /**
      * Return true if there is a target of a specified name.
      */
      public boolean hasTarget(String name);

      /**
      * Return the number of targets.
      */
      public int countTargets();

      /**
      * Return the target of a specified name.
      */
      public Target getTarget(String name);

Zones class

The Zones class has the following API:

      /**
      * Return the map of zones.
      */
      public Map<String, Zone> getZones();

      /**
      * Return true if there is a zone of a specified name.
      */
      public boolean hasZone(String name);

      /**
      * Return the number of zones
      */
      public int countZones();

      /**
      * Return the zone of a specified name.
      */
      public Zone getZone(String name);

Corridors class

The Corridors class has the following API:

      /**
      * Return the map of corridors.
      */
      public Map<String, Corridor> getCorridors();

      /**
      * Return true if there is a corridor of a specified name.
      */
      public boolean hasCorridor(String name);

      /**
      * Return the number of corridors.
      */
      public int countCorridors();

      /**
      * Return the corridor of a specified name.
      */
      public Corridor getCorridor(String name);

Bases class

The Bases class has the following API:

      /**
      * Return the map of bases.
      */
      public Map<String, Base> getBases();

      /**
      * Return true if there is a base of a specified name.
      */
      public boolean hasBase(String name);

      /**
      * Return the number of bases.
      */
      public int countBases();

      /**
      * Return the base of a specified name.
      */
      public Base getBase(String name);

Threats class

The Threats class has the following API:

      /**
      * Return the map of threats.
      */
      public Map<String, Threat> getThreats();

      /**
      * Return true if there is a threat of a specified name.
      */
      public boolean hasThreat(String name);

      /**
      * Return the number of threats.
      */
      public int countThreats();

      /**
      * Return the threat of a specified name.
      */
      public Threat getThreat(String name);

AircraftsModel

The http://dassault-aviation.com/tacticalenv:aircraftsModel service published by the tacticalenvModel module has the following specification:

      <publish name="aircraftsModel">
         <data name="aircrafts" type="aircrafts" />
      </publish>

with the following type:

           <objectType name="aircrafts" class="org.da.protoframework.tacticalenv.common.model.Aircrafts" />

Aircrafts class

The Aircrafts class has the following API:

      /**
      * Return the map of aircrafts.
      */ 
      public Map<String, Aircraft> getAircrafts();

      /**
      * Return true if there is an aircraft of a specified name.
      */
      public boolean hasAircraft(String name);

      /**
      * Return the number of aircrafts.
      */
      public int countAircrafts();

      /**
      * Return the aircraft of a specified name.
      */
      public Aircraft getAircraft(String name);

WaypointsModel

The http://dassault-aviation.com/tacticalenv:waypointsModel service published by the tacticalenvModel module has the following specification:

      <event name="waypointsModel">
         <data name="waypoints" type="waypoints" />
      </event>

with the following type:

           <objectType name="waypoints" class="org.da.protoframework.tacticalenv.common.model.Waypoints" />

Waypoints class

The Waypoints class has the following API:

      /**
      * Return true if there is a Waypoint of a specified name.
      */
      public boolean hasWaypoint(String name);

      /**
      * Return the map of Waypoints.
      */ 
      public Map<String, Waypoint> getWaypoints();

      /**
      * Return the number of Waypoints.
      */
      public int countWaypoints();
   
      /**
      * Return the Waypoint of a specified name.
      */
      public Waypoint getWaypoint(String name);

A Flightplan is an ordered list of Waypoints names.

FlightplansModel

The http://dassault-aviation.com/tacticalenv:flightplansModel service published by the tacticalenvModel module has the following specification:

      <publish name="flightplansModel">
         <data name="flightplans" type="flightplans" />
      </publish>

with the following type:

           <objectType name="flightplans" class="org.da.protoframework.tacticalenv.common.model.Flightplans" />

Flightplans class

The Flightplans class has the following API:

      /**
      * Return true if there is a Flightplan of a specified name.
      */
      public boolean hasFlightplan(String name);

      /**
      * Return the map of Flightplans.
      */ 
      public Map<String, Flightplan> getFlightplans();

      /**
      * Return the number of flightplans.
      */
      public int countFlightplans();
   
      /**
      * Return the Flightplan of a specified name.
      */
      public Flightplan getFlightplan(String name);

A Flightplan is an ordered list of Waypoints names. The Flightplan class has the following API:

      /**
      * Return the Flightplan name.
      */
      public String getName();
      
      /**
      * Return true if the flightplan has no point.
      */
      public boolean isEmpty();

      /**
      * Return the flightplan list of points.
      */
      public List<Point> getPoints();

      /**
      * Add a point.
      */
      public void addPoint(Point point);

      /**
      * Count the number of points.
      */
      public int countPoints();      

      /**
      * Return true if the flightplan has a waypoint of a specified name.
      */
      public boolean hasWaypoint(String waypointID) ;

      /**
      * Return the map of waypoints by their name.
      */
      public Map<String, Integer> getWaypointsMap();

      /**
      * Return the index of a waypoint knowing its name.
      */
      public int getWaypointIndex(String name);

      /**
      * Return the ordered list of waypoints.
      *
      * @return the ordered list of waypoints
      */
      public List<String> getWaypoints();

      /**
      * Count the number of waypoints.
      */
      public int countWaypoints();

As you can see, the Flightplan contains:

• Points
• Waypoints names

CustomElement class

The CustomElement class has the following API:

      /**
      * Return the element type as a String.
      */   
      public String getObjectTypeAsString();
      
      /**
      * Return true if the element has properties.
      */
      public boolean hasProperties();      
      
      /**
      * Return the element properties.
      */
      public Map<String, Object> getProperties();  
      
      /**
      * Return the value of a property.
      */
      public Object getProperty(String name);
      
      /**
      * Return the value of a property as a String.
      */
      public String getPropertyAsString(String name);
      
      /**
      * Return the value of a property as a boolean.
      */
      public boolean getPropertyAsBoolean(String name);   
      
      /**
      * Return the value of a property as a float.
      */
      public float getPropertyAsFloat(String name);  
      
      /**
      * Return the value of a property as an int.
      */
      public int getPropertyAsInt(String name);