-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #323 from andlaus/diag_variables
Implement diagnostic variables
- Loading branch information
Showing
16 changed files
with
718 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
# SPDX-License-Identifier: MIT | ||
import warnings | ||
from dataclasses import dataclass | ||
from enum import Enum | ||
from typing import Any, Dict, List, Optional | ||
from xml.etree import ElementTree | ||
|
||
from .description import Description | ||
from .diagcomm import DiagComm | ||
from .diagservice import DiagService | ||
from .exceptions import OdxWarning, odxraise, odxrequire | ||
from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef, resolve_snref | ||
from .parameters.parameter import Parameter | ||
from .snrefcontext import SnRefContext | ||
|
||
|
||
class CommRelationValueType(Enum): | ||
CURRENT = "CURRENT" | ||
STORED = "STORED" | ||
STATIC = "STATIC" | ||
SUBSTITUTED = "SUBSTITUTED" | ||
|
||
|
||
@dataclass | ||
class CommRelation: | ||
description: Optional[Description] | ||
relation_type: str | ||
diag_comm_ref: Optional[OdxLinkRef] | ||
diag_comm_snref: Optional[str] | ||
in_param_if_snref: Optional[str] | ||
#in_param_if_snpathref: Optional[str] # TODO | ||
out_param_if_snref: Optional[str] | ||
#out_param_if_snpathref: Optional[str] # TODO | ||
value_type_raw: Optional[CommRelationValueType] | ||
|
||
@property | ||
def diag_comm(self) -> DiagComm: | ||
return self._diag_comm | ||
|
||
@property | ||
def in_param_if(self) -> Optional[Parameter]: | ||
return self._in_param_if | ||
|
||
@property | ||
def out_param_if(self) -> Optional[Parameter]: | ||
return self._out_param_if | ||
|
||
@property | ||
def value_type(self) -> CommRelationValueType: | ||
if self.value_type_raw is None: | ||
return CommRelationValueType.CURRENT | ||
|
||
return self.value_type_raw | ||
|
||
@staticmethod | ||
def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) -> "CommRelation": | ||
description = Description.from_et(et_element.find("DESC"), doc_frags) | ||
relation_type = odxrequire(et_element.findtext("RELATION-TYPE")) | ||
|
||
diag_comm_ref = OdxLinkRef.from_et(et_element.find("DIAG-COMM-REF"), doc_frags) | ||
diag_comm_snref = None | ||
if (diag_comm_snref_elem := et_element.find("DIAG-COMM-SNREF")) is not None: | ||
diag_comm_snref = odxrequire(diag_comm_snref_elem.get("SHORT-NAME")) | ||
|
||
in_param_if_snref = None | ||
if (in_param_if_snref_elem := et_element.find("IN-PARAM-IF-SNREF")) is not None: | ||
in_param_if_snref = odxrequire(in_param_if_snref_elem.get("SHORT-NAME")) | ||
|
||
if et_element.find("IN-PARAM-IF-SNPATHREF") is not None: | ||
warnings.warn("SNPATHREFs are not supported by odxtools yet", OdxWarning, stacklevel=1) | ||
|
||
out_param_if_snref = None | ||
if (out_param_if_snref_elem := et_element.find("OUT-PARAM-IF-SNREF")) is not None: | ||
out_param_if_snref = odxrequire(out_param_if_snref_elem.get("SHORT-NAME")) | ||
|
||
if et_element.find("OUT-PARAM-IF-SNPATHREF") is not None: | ||
warnings.warn("SNPATHREFs are not supported by odxtools yet", OdxWarning, stacklevel=1) | ||
|
||
value_type_raw = None | ||
if (value_type_str := et_element.get("VALUE-TYPE")) is not None: | ||
try: | ||
value_type_raw = CommRelationValueType(value_type_str) | ||
except ValueError: | ||
odxraise(f"Encountered unknown comm relation value type '{value_type_str}'") | ||
|
||
return CommRelation( | ||
description=description, | ||
relation_type=relation_type, | ||
diag_comm_ref=diag_comm_ref, | ||
diag_comm_snref=diag_comm_snref, | ||
in_param_if_snref=in_param_if_snref, | ||
out_param_if_snref=out_param_if_snref, | ||
value_type_raw=value_type_raw) | ||
|
||
def _build_odxlinks(self) -> Dict[OdxLinkId, Any]: | ||
return {} | ||
|
||
def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None: | ||
if self.diag_comm_ref is not None: | ||
self._diag_comm = odxlinks.resolve(self.diag_comm_ref, DiagComm) | ||
|
||
def _resolve_snrefs(self, context: SnRefContext) -> None: | ||
diag_layer = odxrequire(context.diag_layer) | ||
|
||
if self.diag_comm_snref is not None: | ||
self._diag_comm = resolve_snref(self.diag_comm_snref, diag_layer.diag_comms, DiagComm) | ||
|
||
service = self.diag_comm | ||
if not isinstance(service, DiagService): | ||
odxraise(f"DIAG-VARIABLE references non-service {type(service).__name__} " | ||
f"diagnostic communication") | ||
|
||
self._in_param_if = None | ||
if self.in_param_if_snref is not None: | ||
self._in_param_if = resolve_snref(self.in_param_if_snref, | ||
odxrequire(service.request).parameters, Parameter) | ||
|
||
self._out_param_if = None | ||
if self.out_param_if_snref is not None: | ||
self._out_param_if = resolve_snref(self.out_param_if_snref, | ||
odxrequire(service.positive_responses[0]).parameters, | ||
Parameter) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# SPDX-License-Identifier: MIT | ||
from dataclasses import dataclass | ||
from typing import Any, Dict, List, Optional | ||
from xml.etree import ElementTree | ||
|
||
from .admindata import AdminData | ||
from .commrelation import CommRelation | ||
from .element import IdentifiableElement | ||
from .exceptions import odxrequire | ||
from .nameditemlist import NamedItemList | ||
from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId, OdxLinkRef | ||
from .odxtypes import odxstr_to_bool | ||
from .snrefcontext import SnRefContext | ||
from .specialdatagroup import SpecialDataGroup | ||
from .swvariable import SwVariable | ||
from .utils import dataclass_fields_asdict | ||
from .variablegroup import VariableGroup | ||
|
||
|
||
@dataclass | ||
class DiagVariable(IdentifiableElement): | ||
"""Representation of a diagnostic variable | ||
""" | ||
|
||
admin_data: Optional[AdminData] | ||
variable_group_ref: OdxLinkRef | ||
sw_variables: List[SwVariable] | ||
comm_relations: List[CommRelation] | ||
#snref_to_tablerow: Optional[SnrefToTableRow] # TODO | ||
sdgs: List[SpecialDataGroup] | ||
is_read_before_write_raw: Optional[bool] | ||
|
||
@property | ||
def variable_group(self) -> VariableGroup: | ||
return self._variable_group | ||
|
||
@property | ||
def is_read_before_write(self) -> bool: | ||
return self.is_read_before_write_raw is True | ||
|
||
@staticmethod | ||
def from_et(et_element: ElementTree.Element, doc_frags: List[OdxDocFragment]) -> "DiagVariable": | ||
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)) | ||
sw_variables = NamedItemList([ | ||
SwVariable.from_et(swv_elem, doc_frags) | ||
for swv_elem in et_element.iterfind("SW-VARIABLES/SW-VARIABLE") | ||
]) | ||
comm_relations = [ | ||
CommRelation.from_et(cr_elem, doc_frags) | ||
for cr_elem in et_element.iterfind("COMM-RELATIONS/COMM-RELATION") | ||
] | ||
sdgs = [ | ||
SpecialDataGroup.from_et(sdge, doc_frags) for sdge in et_element.iterfind("SDGS/SDG") | ||
] | ||
is_read_before_write_raw = odxstr_to_bool(et_element.get("IS-READ-BEFORE-WRITE")) | ||
|
||
return DiagVariable( | ||
admin_data=admin_data, | ||
variable_group_ref=variable_group_ref, | ||
sw_variables=sw_variables, | ||
comm_relations=comm_relations, | ||
sdgs=sdgs, | ||
is_read_before_write_raw=is_read_before_write_raw, | ||
**kwargs) | ||
|
||
def _build_odxlinks(self) -> Dict[OdxLinkId, Any]: | ||
result = {self.odx_id: self} | ||
|
||
if self.admin_data is not None: | ||
result.update(self.admin_data._build_odxlinks()) | ||
|
||
for sdg in self.sdgs: | ||
result.update(sdg._build_odxlinks()) | ||
|
||
for cr in self.comm_relations: | ||
result.update(cr._build_odxlinks()) | ||
|
||
return result | ||
|
||
def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None: | ||
self._variable_group = odxlinks.resolve(self.variable_group_ref, VariableGroup) | ||
|
||
if self.admin_data is not None: | ||
self.admin_data._resolve_odxlinks(odxlinks) | ||
|
||
for sdg in self.sdgs: | ||
sdg._resolve_odxlinks(odxlinks) | ||
|
||
for cr in self.comm_relations: | ||
cr._resolve_odxlinks(odxlinks) | ||
|
||
def _resolve_snrefs(self, context: SnRefContext) -> None: | ||
if self.admin_data is not None: | ||
self.admin_data._resolve_snrefs(context) | ||
|
||
for sdg in self.sdgs: | ||
sdg._resolve_snrefs(context) | ||
|
||
for cr in self.comm_relations: | ||
cr._resolve_snrefs(context) |
Oops, something went wrong.