added type hinting to core.emane functions

daemon/core/emane/emanemodel.py

@@ -3,12 +3,14 @@ Defines Emane Models used within CORE.
 """
 import logging
 import os
+from typing import Dict, List
 
 from core.config import ConfigGroup, Configuration
 from core.emane import emanemanifest
 from core.emulator.enumerations import ConfigDataTypes
 from core.errors import CoreError
 from core.location.mobility import WirelessModel
+from core.nodes.interface import CoreInterface
 from core.xml import emanexml
 
 
@@ -45,7 +47,7 @@ class EmaneModel(WirelessModel):
     config_ignore = set()
 
     @classmethod
-    def load(cls, emane_prefix):
+    def load(cls, emane_prefix: str) -> None:
         """
         Called after being loaded within the EmaneManager. Provides configured emane_prefix for
         parsing xml files.
@@ -63,7 +65,7 @@ class EmaneModel(WirelessModel):
         cls.phy_config = emanemanifest.parse(phy_xml_path, cls.phy_defaults)
 
     @classmethod
-    def configurations(cls):
+    def configurations(cls) -> List[Configuration]:
         """
         Returns the combination all all configurations (mac, phy, and external).
 
@@ -73,7 +75,7 @@ class EmaneModel(WirelessModel):
         return cls.mac_config + cls.phy_config + cls.external_config
 
     @classmethod
-    def config_groups(cls):
+    def config_groups(cls) -> List[ConfigGroup]:
         """
         Returns the defined configuration groups.
 
@@ -89,10 +91,12 @@ class EmaneModel(WirelessModel):
             ConfigGroup("External Parameters", phy_len + 1, config_len),
         ]
 
-    def build_xml_files(self, config, interface=None):
+    def build_xml_files(
+        self, config: Dict[str, str], interface: CoreInterface = None
+    ) -> None:
         """
-        Builds xml files for this emane model. Creates a nem.xml file that points to both mac.xml and phy.xml
-        definitions.
+        Builds xml files for this emane model. Creates a nem.xml file that points to
+        both mac.xml and phy.xml definitions.
 
         :param dict config: emane model configuration for the node and interface
         :param interface: interface for the emane node
@@ -127,7 +131,7 @@ class EmaneModel(WirelessModel):
         phy_file = os.path.join(self.session.session_dir, phy_name)
         emanexml.create_phy_xml(self, config, phy_file, server)
 
-    def post_startup(self):
+    def post_startup(self) -> None:
         """
         Logic to execute after the emane manager is finished with startup.
 
@@ -135,7 +139,7 @@ class EmaneModel(WirelessModel):
         """
         logging.debug("emane model(%s) has no post setup tasks", self.name)
 
-    def update(self, moved, moved_netifs):
+    def update(self, moved: bool, moved_netifs: List[CoreInterface]) -> None:
         """
         Invoked from MobilityModel when nodes are moved; this causes
         emane location events to be generated for the nodes in the moved
@@ -143,7 +147,7 @@ class EmaneModel(WirelessModel):
 
         :param bool moved: were nodes moved
         :param list moved_netifs: interfaces that were moved
-        :return:
+        :return: nothing
         """
         try:
             wlan = self.session.get_node(self.id)
@@ -153,14 +157,14 @@ class EmaneModel(WirelessModel):
 
     def linkconfig(
         self,
-        netif,
-        bw=None,
-        delay=None,
-        loss=None,
-        duplicate=None,
-        jitter=None,
-        netif2=None,
-    ):
+        netif: CoreInterface,
+        bw: float = None,
+        delay: float = None,
+        loss: float = None,
+        duplicate: float = None,
+        jitter: float = None,
+        netif2: CoreInterface = None,
+    ) -> None:
         """
         Invoked when a Link Message is received. Default is unimplemented.