Merge pull request #387 from andlaus/complete_diag_variable

DiagVariable: internalize remaining functionality

Author: andlaus

odxtools/diagvariable.py

@@ -9,11 +9,13 @@
 from .element import IdentifiableElement
 from .exceptions import odxrequire
 from .nameditemlist import NamedItemList
-from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef
+from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef, resolve_snref
 from .odxtypes import odxstr_to_bool
 from .snrefcontext import SnRefContext
 from .specialdatagroup import SpecialDataGroup
 from .swvariable import SwVariable
+from .table import Table
+from .tablerow import TableRow
 from .utils import dataclass_fields_asdict
 from .variablegroup import VariableGroup
 
@@ -32,15 +34,30 @@ class DiagVariable(IdentifiableElement):
     """
 
     admin_data: Optional[AdminData]
-    variable_group_ref: OdxLinkRef
+    variable_group_ref: Optional[OdxLinkRef]
     sw_variables: List[SwVariable]
+
+    # a diag variable must specify either COMM-RELATIONS or a
+    # reference to a table row
     comm_relations: List[CommRelation]
-    #snref_to_tablerow: Optional[SnrefToTableRow] # TODO
+
+    # these are nested inside the SNREF-TO-TABLEROW tag
+    table_snref: Optional[str]
+    table_row_snref: Optional[str]
+
     sdgs: List[SpecialDataGroup]
     is_read_before_write_raw: Optional[bool]
 
     @property
-    def variable_group(self) -> VariableGroup:
+    def table(self) -> Optional[Table]:
+        return self._table
+
+    @property
+    def table_row(self) -> Optional[TableRow]:
+        return self._table_row
+
+    @property
+    def variable_group(self) -> Optional[VariableGroup]:
         return self._variable_group
 
     @property
@@ -52,8 +69,7 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
         kwargs = dataclass_fields_asdict(IdentifiableElement.from_et(et_element, doc_frags))
 
         admin_data = AdminData.from_et(et_element.find("ADMIN-DATA"), doc_frags)
-        variable_group_ref = odxrequire(
-            OdxLinkRef.from_et(et_element.find("VARIABLE-GROUP-REF"), doc_frags))
+        variable_group_ref = OdxLinkRef.from_et(et_element.find("VARIABLE-GROUP-REF"), doc_frags)
         sw_variables = NamedItemList([
             SwVariable.from_et(swv_elem, doc_frags)
             for swv_elem in et_element.iterfind("SW-VARIABLES/SW-VARIABLE")
@@ -62,6 +78,16 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
             CommRelation.from_et(cr_elem, doc_frags)
             for cr_elem in et_element.iterfind("COMM-RELATIONS/COMM-RELATION")
         ]
+
+        table_snref = None
+        table_row_snref = None
+        if (snref_to_tablerow_elem := et_element.find("SNREF-TO-TABLEROW")) is not None:
+            table_snref_elem = odxrequire(snref_to_tablerow_elem.find("TABLE-SNREF"))
+            table_snref = odxrequire(table_snref_elem.attrib.get("SHORT-NAME"))
+
+            table_row_snref_elem = odxrequire(snref_to_tablerow_elem.find("TABLE-ROW-SNREF"))
+            table_row_snref = odxrequire(table_row_snref_elem.attrib.get("SHORT-NAME"))
+
         sdgs = [
             SpecialDataGroup.from_et(sdge, doc_frags) for sdge in et_element.iterfind("SDGS/SDG")
         ]
@@ -72,6 +98,8 @@ def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) ->
             variable_group_ref=variable_group_ref,
             sw_variables=sw_variables,
             comm_relations=comm_relations,
+            table_snref=table_snref,
+            table_row_snref=table_row_snref,
             sdgs=sdgs,
             is_read_before_write_raw=is_read_before_write_raw,
             **kwargs)
@@ -91,7 +119,9 @@ def _build_odxlinks(self) -> Dict[OdxLinkId, Any]:
         return result
 
     def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None:
-        self._variable_group = odxlinks.resolve(self.variable_group_ref, VariableGroup)
+        self._variable_group = None
+        if self.variable_group_ref is not None:
+            self._variable_group = odxlinks.resolve(self.variable_group_ref, VariableGroup)
 
         if self.admin_data is not None:
             self.admin_data._resolve_odxlinks(odxlinks)
@@ -111,3 +141,11 @@ def _resolve_snrefs(self, context: SnRefContext) -> None:
 
         for cr in self.comm_relations:
             cr._resolve_snrefs(context)
+
+        self._table = None
+        self._table_row = None
+        if self.table_snref is not None:
+            ddds = odxrequire(context.diag_layer).diag_data_dictionary_spec
+            self._table = resolve_snref(self.table_snref, ddds.tables, Table)
+            self._table_row = resolve_snref(
+                odxrequire(self.table_row_snref), self._table.table_rows, TableRow)

odxtools/templates/macros/printDiagVariable.xml.jinja2

@@ -5,16 +5,18 @@
 {%- import('macros/printElementId.xml.jinja2') as peid %}
 {%- import('macros/printAdminData.xml.jinja2') as pad %}
 {%- import('macros/printDescription.xml.jinja2') as pd %}
+{%- import('macros/printSpecialData.xml.jinja2') as psd %}
 
 {%- macro printDiagVariable(diag_var) -%}
-<DIAG-VARIABLE {{-peid.printElementIdAttribs(diag_var)}}>
+<DIAG-VARIABLE {{-peid.printElementIdAttribs(diag_var)}}
+               {{-make_bool_xml_attrib("IS-READ-BEFORE-WRITE", diag_var.is_read_before_write_raw}}>
   {{ peid.printElementIdSubtags(diag_variable)|indent(2) }}
   {%- if diag_variable.admin_data is not none %}
   {{ pad.printAdminData(diag_variable.admin_data)|indent(2) }}
   {%- endif %}
   <VARIABLE-GROUP-REF ID-REF="{{ diag_var.ref_id }}" />
   {%- if diag_variable.sw_variables %}
-  <SW-VARIABLES>
+   <SW-VARIABLES>
     {%- for sw_var in diag_variable.sw_variables %}
     <SW-VARIABLE {{-peid.printElementIdAttribs(sw_var)}}>
       {{ peid.printElementIdSubtags(sw_var)|indent(6) }}
@@ -56,6 +58,13 @@
     {%- endfor %}
   </COMM-RELATIONS>
   {%- endif %}
+  {%- if diag_variable.table_snref is not none %}
+  <SNREF-TO-TABLE-ROW>
+    <TABLE-SNREF SHORT-NAME="{{diag_variable.table_snref}}" />
+    <TABLE-ROW-SNREF SHORT-NAME="{{diag_variable.table_row_snref}}" />
+  </SNREF-TO-TABLE-ROW>
+  {%- endif %}
+  {{- psd.printSpecialDataGroups(ddds.sdgs)|indent(2, first=True) }}
 </DIAG-VARIABLE>
 {%- endmacro -%}