Source code for ansys.dyna.core.lib.field

# Copyright (C) 2021 - 2024 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import copy
import dataclasses
import typing


@dataclasses.dataclass
[docs] class Flag:
[docs] value: bool = None
[docs] true_value: str = None
[docs] false_value: str = None
[docs] class Field: def __init__(self, name: str, type: type, offset: int, width: int, value: typing.Any = None): self._name = name self._type = type self._offset = offset self._width = width self._value = value @property
[docs] def name(self) -> str: return self._name
@name.setter def name(self, value: str) -> None: self._name = value @property
[docs] def type(self) -> type: return self._type
@type.setter def type(self, value: type) -> None: self._type = value @property
[docs] def offset(self) -> int: return self._offset
@offset.setter def offset(self, value: int) -> None: self._offset = value @property
[docs] def width(self) -> int: return self._width
@width.setter def width(self, value: int) -> None: self._width = value @property
[docs] def value(self) -> typing.Any: if self._value and type(self._value) == Flag: return self._value.value return self._value
@value.setter def value(self, value: typing.Any) -> None: if self._value and type(self._value) == Flag: self._value.value = value else: self._value = value
[docs] def io_info(self) -> typing.Tuple[str, typing.Type]: """Return the value and type used for io.""" if self._value and type(self._value) == Flag: value = self._value.true_value if self._value.value else self._value.false_value return value, str return self.value, self.type
[docs] def to_long(field: Field, offset: int) -> Field: field = copy.copy(field) width = field.width if width < 20: width = 20 field.offset = offset field.width = width offset += width return field