-
Notifications
You must be signed in to change notification settings - Fork 81
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 #298 from andlaus/dynamic_endmarker_fields
Implement dynamic endmarker fields
- Loading branch information
Showing
12 changed files
with
575 additions
and
17 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
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,119 @@ | ||
| # SPDX-License-Identifier: MIT | ||
| from dataclasses import dataclass | ||
| from typing import TYPE_CHECKING, Any, Dict, List | ||
| from xml.etree import ElementTree | ||
|
|
||
| from typing_extensions import override | ||
|
|
||
| from .dataobjectproperty import DataObjectProperty | ||
| from .decodestate import DecodeState | ||
| from .dynenddopref import DynEndDopRef | ||
| from .encodestate import EncodeState | ||
| from .exceptions import DecodeError, EncodeError, odxassert, odxraise, odxrequire | ||
| from .field import Field | ||
| from .odxlink import OdxDocFragment, OdxLinkDatabase, OdxLinkId | ||
| from .odxtypes import AtomicOdxType, ParameterValue | ||
| from .utils import dataclass_fields_asdict | ||
|
|
||
| if TYPE_CHECKING: | ||
| from .diaglayer import DiagLayer | ||
|
|
||
|
|
||
| @dataclass | ||
| class DynamicEndmarkerField(Field): | ||
| """Array of a structure with variable length determined by a termination sequence""" | ||
|
|
||
| dyn_end_dop_ref: DynEndDopRef | ||
|
|
||
| @staticmethod | ||
| def from_et(et_element: ElementTree.Element, | ||
| doc_frags: List[OdxDocFragment]) -> "DynamicEndmarkerField": | ||
| kwargs = dataclass_fields_asdict(Field.from_et(et_element, doc_frags)) | ||
|
|
||
| dyn_end_dop_ref = DynEndDopRef.from_et( | ||
| odxrequire(et_element.find("DYN-END-DOP-REF")), doc_frags) | ||
|
|
||
| return DynamicEndmarkerField(dyn_end_dop_ref=dyn_end_dop_ref, **kwargs) | ||
|
|
||
| def _build_odxlinks(self) -> Dict[OdxLinkId, Any]: | ||
| odxlinks = super()._build_odxlinks() | ||
| return odxlinks | ||
|
|
||
| def _resolve_odxlinks(self, odxlinks: OdxLinkDatabase) -> None: | ||
| super()._resolve_odxlinks(odxlinks) | ||
|
|
||
| self._dyn_end_dop = odxlinks.resolve(self.dyn_end_dop_ref, DataObjectProperty) | ||
|
|
||
| tv_string = self.dyn_end_dop_ref.termination_value_raw | ||
| tv_physical = self._dyn_end_dop.diag_coded_type.base_data_type.from_string(tv_string) | ||
|
|
||
| self._termination_value = tv_physical | ||
|
|
||
| def _resolve_snrefs(self, diag_layer: "DiagLayer") -> None: | ||
| super()._resolve_snrefs(diag_layer) | ||
|
|
||
| @property | ||
| def dyn_end_dop(self) -> DataObjectProperty: | ||
| return self._dyn_end_dop | ||
|
|
||
| @property | ||
| def termination_value(self) -> AtomicOdxType: | ||
| return self._termination_value | ||
|
|
||
| @override | ||
| def encode_into_pdu(self, physical_value: ParameterValue, encode_state: EncodeState) -> None: | ||
|
|
||
| odxassert(encode_state.cursor_bit_position == 0, | ||
| "No bit position can be specified for dynamic endmarker fields!") | ||
| if not isinstance(physical_value, (tuple, list)): | ||
| odxraise( | ||
| f"Expected a sequence of values for dynamic endmarker field {self.short_name}, " | ||
| f"got {type(physical_value).__name__}", EncodeError) | ||
| return | ||
|
|
||
| orig_is_end_of_pdu = encode_state.is_end_of_pdu | ||
| encode_state.is_end_of_pdu = False | ||
| for i, item in enumerate(physical_value): | ||
| if i == len(physical_value) - 1: | ||
| encode_state.is_end_of_pdu = orig_is_end_of_pdu | ||
|
|
||
| self.structure.encode_into_pdu(item, encode_state) | ||
| encode_state.is_end_of_pdu = orig_is_end_of_pdu | ||
|
|
||
| if not encode_state.is_end_of_pdu: | ||
| # only add an endmarker if we are not at the end of the PDU | ||
| self.dyn_end_dop.encode_into_pdu(self.termination_value, encode_state) | ||
|
|
||
| @override | ||
| def decode_from_pdu(self, decode_state: DecodeState) -> ParameterValue: | ||
|
|
||
| odxassert(decode_state.cursor_bit_position == 0, | ||
| "No bit position can be specified for dynamic endmarker fields!") | ||
|
|
||
| orig_origin = decode_state.origin_byte_position | ||
| orig_cursor = decode_state.cursor_byte_position | ||
| decode_state.origin_byte_position = decode_state.cursor_byte_position | ||
|
|
||
| result: List[ParameterValue] = [] | ||
| while True: | ||
| # check if we're at the end of the PDU | ||
| if decode_state.cursor_byte_position == len(decode_state.coded_message): | ||
| break | ||
|
|
||
| # check if the cursor currently points to a termination | ||
| # value | ||
| tmp_cursor = decode_state.cursor_byte_position | ||
| try: | ||
| tv_candidate = self.dyn_end_dop.decode_from_pdu(decode_state) | ||
| if tv_candidate == self.termination_value: | ||
| break | ||
| except DecodeError: | ||
| pass | ||
| decode_state.cursor_byte_position = tmp_cursor | ||
|
|
||
| result.append(self.structure.decode_from_pdu(decode_state)) | ||
|
|
||
| decode_state.origin_byte_position = orig_origin | ||
| decode_state.cursor_byte_position = max(orig_cursor, decode_state.cursor_byte_position) | ||
|
|
||
| return result |
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,38 @@ | ||
| # SPDX-License-Identifier: MIT | ||
| from dataclasses import dataclass | ||
| from typing import List, Optional, overload | ||
| from xml.etree import ElementTree | ||
|
|
||
| from .exceptions import odxraise, odxrequire | ||
| from .odxlink import OdxDocFragment, OdxLinkRef | ||
| from .utils import dataclass_fields_asdict | ||
|
|
||
|
|
||
| @dataclass | ||
| class DynEndDopRef(OdxLinkRef): | ||
| termination_value_raw: str | ||
|
|
||
| @staticmethod | ||
| @overload | ||
| def from_et(et_element: None, source_doc_frags: List[OdxDocFragment]) -> None: | ||
| ... | ||
|
|
||
| @staticmethod | ||
| @overload | ||
| def from_et(et_element: ElementTree.Element, | ||
| source_doc_frags: List[OdxDocFragment]) -> "DynEndDopRef": | ||
| ... | ||
|
|
||
| @staticmethod | ||
| def from_et(et_element: Optional[ElementTree.Element], | ||
| source_doc_frags: List[OdxDocFragment]) -> Optional["DynEndDopRef"]: | ||
|
|
||
| if et_element is None: | ||
| odxraise("Mandatory DYN-END-DOP-REF tag is missing") | ||
| return None | ||
|
|
||
| kwargs = dataclass_fields_asdict(OdxLinkRef.from_et(et_element, source_doc_frags)) | ||
|
|
||
| termination_value_raw = odxrequire(et_element.findtext("TERMINATION-VALUE")) | ||
|
|
||
| return DynEndDopRef(termination_value_raw=termination_value_raw, **kwargs) |
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
16 changes: 16 additions & 0 deletions
16
odxtools/templates/macros/printDynamicEndmarkerField.xml.jinja2
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,16 @@ | ||
| {#- -*- mode: sgml; tab-width: 1; indent-tabs-mode: nil -*- | ||
| # | ||
| # SPDX-License-Identifier: MIT | ||
| -#} | ||
|
|
||
| {%- import('macros/printElementId.xml.jinja2') as peid %} | ||
|
|
||
| {%- macro printStaticField(demf) -%} | ||
| <DYNAMIC-ENDMARKER-FIELD ID="{{demf.odx_id.local_id}}"> | ||
| {{ peid.printElementIdSubtags(demf)|indent(1) }} | ||
| <BASIC-STRUCTURE-REF ID-REF="{{demf.structure_ref.ref_id}}" /> | ||
| <DYN-END-DOP-REF ID-REF="{{demf.dyn_end_dop_ref.ref_id}}"> | ||
| <TERMINATION-VALUE>{{demf.dyn_end_dop_ref.termination_value_raw}}</TERMINATION-VALUE> | ||
| </DYN-END-DOP-REF> | ||
| </DYNAMIC-ENDMARKER-FIELD> | ||
| {%- endmacro -%} |
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
Oops, something went wrong.