Merge pull request #223 from andlaus/minor_cleanups

Minor cleanups
mercedes-benz · Oct 27, 2023 · d5ca112 · d5ca112
2 parents 1b77e23 + 5909e08
commit d5ca112
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 35 deletions.
diff --git a/examples/somersaultecu.py b/examples/somersaultecu.py
@@ -1820,7 +1820,6 @@ class SomersaultSID(IntEnum):
         value="500000",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # parameters of the CAN diagnostics frames
@@ -1850,7 +1849,6 @@ class SomersaultSID(IntEnum):
         ],
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # timeout for responses [us]
@@ -1859,7 +1857,6 @@ class SomersaultSID(IntEnum):
         value="1000000",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     ###
@@ -1871,7 +1868,6 @@ class SomersaultSID(IntEnum):
         value=f"{tester_present_value.hex()}",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # a response is mandatory
@@ -1880,7 +1876,6 @@ class SomersaultSID(IntEnum):
         value="Response expected",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # positive response to "tester present"
@@ -1889,7 +1884,6 @@ class SomersaultSID(IntEnum):
         value=f"{tester_pr_value.hex()}",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # negative response to "tester present"
@@ -1898,7 +1892,6 @@ class SomersaultSID(IntEnum):
         value=f"{tester_nr_value.hex()}",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # when a tester present message must be send
@@ -1907,7 +1900,6 @@ class SomersaultSID(IntEnum):
         value="On idle",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # "tester present" messages are send directly to the CAN IDs
@@ -1917,7 +1909,6 @@ class SomersaultSID(IntEnum):
         value="Physical",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     # is a response from the ECU to "tester present" messages expected
@@ -1926,7 +1917,6 @@ class SomersaultSID(IntEnum):
         value="Response expected",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
     ###
@@ -1938,7 +1928,6 @@ class SomersaultSID(IntEnum):
         value="4",
         protocol_snref="MyProtocol",
         prot_stack_snref=None,
-        is_functional=False,
         description=None,
     ),
 ]

diff --git a/odxtools/communicationparameterref.py b/odxtools/communicationparameterref.py
@@ -7,7 +7,6 @@
 from .basecomparam import BaseComparam
 from .comparam import Comparam
 from .complexcomparam import ComplexComparam, ComplexValue, create_complex_value_from_et
-from .diaglayertype import DiagLayerType
 from .exceptions import OdxWarning, odxassert, odxraise, odxrequire
 from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef
 from .utils import create_description_from_et
@@ -23,11 +22,10 @@ class CommunicationParameterRef:
     protocol_snref: Optional[str]
     prot_stack_snref: Optional[str]
     id_ref: OdxLinkRef
-    is_functional: bool
 
     @staticmethod
-    def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment],
-                dl_type: DiagLayerType) -> "CommunicationParameterRef":
+    def from_et(et_element: ElementTree.Element,
+                doc_frags: List[OdxDocFragment]) -> "CommunicationParameterRef":
         id_ref = odxrequire(OdxLinkRef.from_et(et_element, doc_frags))
 
         # ODX standard v2.0.0 defined only VALUE. ODX v2.0.1 decided
@@ -41,7 +39,6 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment],
         else:
             value = create_complex_value_from_et(odxrequire(et_element.find("COMPLEX-VALUE")))
 
-        is_functional = dl_type == DiagLayerType.FUNCTIONAL_GROUP
         description = create_description_from_et(et_element.find("DESC"))
 
         prot_stack_snref = None
@@ -55,7 +52,6 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment],
         return CommunicationParameterRef(
             value=value,
             id_ref=id_ref,
-            is_functional=is_functional,
             description=description,
             protocol_snref=protocol_snref,
             prot_stack_snref=prot_stack_snref,

diff --git a/odxtools/diaglayer.py b/odxtools/diaglayer.py
@@ -585,7 +585,7 @@ def communication_parameters(self) -> NamedItemList[CommunicationParameterRef]:
         """
         return self._communication_parameters
 
-    @property
+    @cached_property
     def protocols(self) -> NamedItemList["DiagLayer"]:
         """Return the set of all protocols which are applicable to the diagnostic layer
 
@@ -607,7 +607,6 @@ def get_communication_parameter(
         self,
         cp_short_name: str,
         *,
-        is_functional: Optional[bool] = None,
         protocol_name: Optional[str] = None,
     ) -> Optional[CommunicationParameterRef]:
         """Find a specific communication parameter according to some criteria.
@@ -616,8 +615,6 @@ def get_communication_parameter(
 
         # determine the set of applicable communication parameters
         cps = [cp for cp in self.communication_parameters if cp.short_name == cp_short_name]
-        if is_functional is not None:
-            cps = [cp for cp in cps if cp.is_functional in (None, is_functional)]
         if protocol_name is not None:
             cps = [cp for cp in cps if cp.protocol_snref in (None, protocol_name)]
 
@@ -714,7 +711,7 @@ def get_doip_logical_ecu_address(self, protocol_name: Optional[str] = None) -> O
         # ISO_15765_2 subset for CAN. If the wrong one is retrieved,
         # try specifying the protocol_name.)
         com_param = self.get_communication_parameter(
-            "CP_UniqueRespIdTable", protocol_name=protocol_name, is_functional=False)
+            "CP_UniqueRespIdTable", protocol_name=protocol_name)
 
         if com_param is None:
             return None
@@ -732,16 +729,13 @@ def get_doip_logical_ecu_address(self, protocol_name: Optional[str] = None) -> O
         return int(ecu_addr)
 
     def get_doip_logical_gateway_address(self,
-                                         protocol_name: Optional[str] = None,
-                                         is_functional: Optional[bool] = False) -> Optional[int]:
+                                         protocol_name: Optional[str] = None) -> Optional[int]:
         """The logical gateway address for the diagnosis over IP transport protocol"""
 
         # retrieve CP_DoIPLogicalGatewayAddress from the
         # ISO_13400_2_DIS_2015 subset. hopefully.
         com_param = self.get_communication_parameter(
-            "CP_DoIPLogicalGatewayAddress",
-            is_functional=is_functional,
-            protocol_name=protocol_name)
+            "CP_DoIPLogicalGatewayAddress", protocol_name=protocol_name)
         if com_param is None:
             return None
 
@@ -752,15 +746,13 @@ def get_doip_logical_gateway_address(self,
 
         return int(result)
 
-    def get_doip_logical_tester_address(self,
-                                        protocol_name: Optional[str] = None,
-                                        is_functional: Optional[bool] = False) -> Optional[int]:
+    def get_doip_logical_tester_address(self, protocol_name: Optional[str] = None) -> Optional[int]:
         """DoIp logical gateway address"""
 
         # retrieve CP_DoIPLogicalTesterAddress from the
         # ISO_13400_2_DIS_2015 subset. hopefully.
         com_param = self.get_communication_parameter(
-            "CP_DoIPLogicalTesterAddress", is_functional=is_functional, protocol_name=protocol_name)
+            "CP_DoIPLogicalTesterAddress", protocol_name=protocol_name)
         if com_param is None:
             return None
 
@@ -772,15 +764,13 @@ def get_doip_logical_tester_address(self,
         return int(result)
 
     def get_doip_logical_functional_address(self,
-                                            protocol_name: Optional[str] = None,
-                                            is_functional: Optional[bool] = False) -> Optional[int]:
+                                            protocol_name: Optional[str] = None) -> Optional[int]:
         """The logical functional DoIP address of the ECU."""
 
         # retrieve CP_DoIPLogicalFunctionalAddress from the
         # ISO_13400_2_DIS_2015 subset. hopefully.
         com_param = self.get_communication_parameter(
             "CP_DoIPLogicalFunctionalAddress",
-            is_functional=is_functional,
             protocol_name=protocol_name,
         )
         if com_param is None:

diff --git a/odxtools/diaglayerraw.py b/odxtools/diaglayerraw.py
@@ -163,7 +163,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
         ]
 
         communication_parameters = [
-            CommunicationParameterRef.from_et(el, doc_frags, variant_type)
+            CommunicationParameterRef.from_et(el, doc_frags)
             for el in et_element.iterfind("COMPARAM-REFS/COMPARAM-REF")
         ]