esmf-aspect-model-loader 0.1.2__py3-none-any.whl

esmf_aspect_meta_model_python/__init__.py

@@ -0,0 +1,88 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from .base import (
+    AbstractEntity,
+    Aspect,
+    Base,
+    BoundDefinition,
+    Characteristic,
+    Code,
+    Collection,
+    ComplexType,
+    Constraint,
+    DataType,
+    Duration,
+    Either,
+    EncodingConstraint,
+    Entity,
+    Enumeration,
+    Event,
+    FixedPointConstraint,
+    LanguageConstraint,
+    LengthConstraint,
+    List,
+    LocaleConstraint,
+    Measurement,
+    Operation,
+    Property,
+    Quantifiable,
+    QuantityKind,
+    RangeConstraint,
+    RegularExpressionConstraint,
+    Scalar,
+    Set,
+    SingleEntity,
+    SortedSet,
+    State,
+    StructuredValue,
+    TimeSeries,
+    Trait,
+    Unit,
+)
+from .impl import (
+    BaseImpl,
+    DefaultAbstractEntity,
+    DefaultAspect,
+    DefaultCharacteristic,
+    DefaultCode,
+    DefaultCollection,
+    DefaultComplexType,
+    DefaultConstraint,
+    DefaultDuration,
+    DefaultEither,
+    DefaultEncodingConstraint,
+    DefaultEntity,
+    DefaultEnumeration,
+    DefaultEvent,
+    DefaultFixedPointConstraint,
+    DefaultLanguageConstraint,
+    DefaultLengthConstraint,
+    DefaultList,
+    DefaultLocaleConstraint,
+    DefaultMeasurement,
+    DefaultOperation,
+    DefaultProperty,
+    DefaultQuantifiable,
+    DefaultQuantityKind,
+    DefaultRangeConstraint,
+    DefaultRegularExpressionConstraint,
+    DefaultScalar,
+    DefaultSet,
+    DefaultSingleEntity,
+    DefaultSortedSet,
+    DefaultState,
+    DefaultStructuredValue,
+    DefaultTimeSeries,
+    DefaultTrait,
+    DefaultUnit,
+)
+from .loader.aspect_loader import AspectLoader

esmf_aspect_meta_model_python/base/README.md

@@ -0,0 +1,48 @@
+# Base
+This folder contains a minimum definition of the elements in the SAMM. The folder does not include any implementations. 
+It can be seen as a contract that establishes a fixed structure and inheritance hierarchy.
+The classes should not be instantiated because they are abstract which is similar to interfaces in Java.
+
+# Inheritance hierarchy
+```
+HasUrn
+├───────────────────────────────────────────────── DataType
+└── IsDescribed                                    ├── Scalar
+    └── Base                    HasProperties      │
+        ├── StructureElement <──┘                  │
+        │   ├── Aspect                             │
+        │   └── ComplexType <──────────────────────┘
+        │       ├── AbstractEntity                 
+        │       └── Entity
+        ├── Characteristic
+        │   ├── Code
+        │   ├── Collection
+        │   │   ├── List
+        │   │   ├── Set
+        │   │   └── SortedSet
+        │   │       └── TimeSeries
+        │   ├── Either
+        │   ├── Enumeration
+        │   │   └── State
+        │   ├── SingleEntity
+        │   ├── StructuredValue
+        │   ├── Quantifiable
+		│   │   ├── Duration
+		│   │   └── Measurement
+		│   └── Trait
+        ├── Constraint
+        │   ├── EncodingConstraint
+        │   ├── FixedPointConstraint
+        │   ├── LanguageConstraint
+        │   ├── LengthConstraint
+        │   ├── LocaleConstraint
+        │   ├── RangeConstraint
+        │   └── RegularExpressionConstraint
+		├── Event
+        ├── Operation
+        ├── Property
+        ├── QuantityKind           
+        └── Unit
+
+BoundDefiniton
+```

esmf_aspect_meta_model_python/base/__init__.py

@@ -0,0 +1,48 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from .aspect import Aspect
+from .base import Base
+from .bound_definition import BoundDefinition
+from .characteristics.characteristic import Characteristic
+from .characteristics.code import Code
+from .characteristics.collection.collection import Collection
+from .characteristics.collection.list import List
+from .characteristics.collection.set import Set
+from .characteristics.collection.sorted_set import SortedSet
+from .characteristics.collection.time_series import TimeSeries
+from .characteristics.either import Either
+from .characteristics.enumeration import Enumeration
+from .characteristics.quantifiable.duration import Duration
+from .characteristics.quantifiable.measurement import Measurement
+from .characteristics.quantifiable.quantifiable import Quantifiable
+from .characteristics.single_entity import SingleEntity
+from .characteristics.state import State
+from .characteristics.structured_value import StructuredValue
+from .characteristics.trait import Trait
+from .contraints.constraint import Constraint
+from .contraints.encoding_constraint import EncodingConstraint
+from .contraints.fixed_point_constraint import FixedPointConstraint
+from .contraints.language_constraint import LanguageConstraint
+from .contraints.length_constraint import LengthConstraint
+from .contraints.locale_constraint import LocaleConstraint
+from .contraints.range_constraint import RangeConstraint
+from .contraints.regular_expression_constraint import RegularExpressionConstraint
+from .data_types.abstract_entity import AbstractEntity
+from .data_types.complex_type import ComplexType
+from .data_types.data_type import DataType
+from .data_types.entity import Entity
+from .data_types.scalar import Scalar
+from .event import Event
+from .operation import Operation
+from .property import Property
+from .quantity_kind import QuantityKind
+from .unit import Unit

esmf_aspect_meta_model_python/base/aspect.py

@@ -0,0 +1,41 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+from typing import List
+
+from esmf_aspect_meta_model_python.base.event import Event
+from esmf_aspect_meta_model_python.base.operation import Operation
+from esmf_aspect_meta_model_python.base.structure_element import StructureElement
+
+
+class Aspect(StructureElement, ABC):
+    """Aspect interface class.
+
+    An aspect is the root class for a digital twin.
+    It has a number of properties and operations.
+    An Aspect Model is described in RDF Turtle.
+    """
+
+    @property
+    @abstractmethod
+    def operations(self) -> List[Operation]:
+        """Operations."""
+
+    @property
+    @abstractmethod
+    def events(self) -> List[Event]:
+        """Events."""
+
+    @property
+    def is_collection_aspect(self) -> bool:
+        """Is collection aspect flag."""
+        return False

esmf_aspect_meta_model_python/base/base.py

@@ -0,0 +1,36 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from esmf_aspect_meta_model_python.base.is_described import IsDescribed
+
+
+class Base(IsDescribed, ABC):
+    """Base interface class.
+
+    Superclass from which all elements in the Meta Model inherit.
+    """
+
+    @property
+    @abstractmethod
+    def parent_elements(self) -> Optional[list["Base"]]:
+        """Parent elements."""
+
+    @parent_elements.setter
+    @abstractmethod
+    def parent_elements(self, elements: list["Base"]) -> None:
+        """Parent elements setter."""
+
+    @abstractmethod
+    def append_parent_element(self, element: "Base") -> None:
+        """Add parent element."""

esmf_aspect_meta_model_python/base/bound_definition.py

@@ -0,0 +1,27 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+import enum
+
+
+@enum.unique
+class BoundDefinition(enum.Enum):
+    """Bound Definition class.
+
+    Enumeration that holds the specifies the upper or lower boundary rule for a range constraint.
+    Possible values are: OPEN, AT_LEAST, GREATER_THAN, LESS_THAN, AT_MOST
+    """
+
+    OPEN = "OPEN"
+    AT_LEAST = "AT_LEAST"
+    GREATER_THAN = "GREATER_THAN"
+    LESS_THAN = "LESS_THAN"
+    AT_MOST = "AT_MOST"

esmf_aspect_meta_model_python/base/cache_strategy.py

@@ -0,0 +1,66 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+
+from esmf_aspect_meta_model_python.base.base import Base
+
+
+class CacheStrategy(ABC):
+    """Cache Strategy interface class."""
+
+    @abstractmethod
+    def reset(self) -> None:
+        """Reset all cached elements."""
+
+    @abstractmethod
+    def get(self, key: str) -> Base | None:
+        """Gets a Base, and returns the element or undefined.
+
+        Args:
+            key (str): key key of the element.
+
+        Returns:
+            Base | None: Element or undefined if it does not exist.
+        """
+
+    @abstractmethod
+    def get_by_name(self, name: str) -> list[Base]:
+        """Get element by name.
+
+        Args:
+            name (str): name of the element.
+
+        Returns:
+            list[Base]: the found elements or an empty list.
+        """
+
+    @abstractmethod
+    def resolve_instance(self, model_element: Base) -> Base:
+        """Resolve cached element instance or add the given element to the cache.
+
+        Args:
+            model_element (Base): modelElement element instance to resolve
+
+        Returns:
+            Base: cached element instance.
+        """
+
+    @abstractmethod
+    def add_element(self, name: str, model_element: Base, overwrite: bool = False) -> None:
+        """Add element explicitly to the cache.
+
+        Args:
+            name (str): name of the element
+            model_element (Base): element instance to resolve
+            overwrite (_type_, optional): force to overwrite it if an element with the
+                name already exists. Defaults to False:bool.
+        """

esmf_aspect_meta_model_python/base/characteristics/__init__.py

@@ -0,0 +1,10 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0

esmf_aspect_meta_model_python/base/characteristics/characteristic.py

@@ -0,0 +1,29 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+
+from esmf_aspect_meta_model_python.base.base import Base
+from esmf_aspect_meta_model_python.base.data_types.data_type import DataType
+
+
+class Characteristic(Base, ABC):
+    """Characteristic interface class.
+
+    Specifies a property by describing its data type.
+    Multiple classes inherit from Characteristic which describe the property in a more specific way
+    (e.g. Enumeration or Collection).
+    """
+
+    @property
+    @abstractmethod
+    def data_type(self) -> DataType:
+        """Data type."""

esmf_aspect_meta_model_python/base/characteristics/code.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.characteristic import Characteristic
+
+
+class Code(Characteristic, ABC):
+    """Code interface class.
+
+    Describes a Property which contains any kind of code.
+    """

esmf_aspect_meta_model_python/base/characteristics/collection/__init__.py

@@ -0,0 +1,10 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0

esmf_aspect_meta_model_python/base/characteristics/collection/collection.py

@@ -0,0 +1,29 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from esmf_aspect_meta_model_python.base.characteristics.characteristic import Characteristic
+
+
+class Collection(Characteristic, ABC):
+    """Collection interface class.
+
+    Describes a property that has a group of values of the same type.
+    It can have a reference to another characteristic which describes an actual value of the collection.
+    The values are not ordered and may include duplicates.
+    """
+
+    @property
+    @abstractmethod
+    def element_characteristic(self) -> Optional[Characteristic]:
+        """Element characteristic."""

esmf_aspect_meta_model_python/base/characteristics/collection/list.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.collection.collection import Collection
+
+
+class List(Collection, ABC):
+    """List interface class.
+
+    Collection with ordered elements and allowed duplicates.
+    """

esmf_aspect_meta_model_python/base/characteristics/collection/set.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.collection.collection import Collection
+
+
+class Set(Collection, ABC):
+    """Set interface class.
+
+    Collection with unordered elements and without duplicates.
+    """

esmf_aspect_meta_model_python/base/characteristics/collection/sorted_set.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.collection.collection import Collection
+
+
+class SortedSet(Collection, ABC):
+    """Sorted Set interface class.
+
+    Collection with ordered elements and without duplicates.
+    """

esmf_aspect_meta_model_python/base/characteristics/collection/time_series.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.collection.sorted_set import SortedSet
+
+
+class TimeSeries(SortedSet, ABC):
+    """Time Series interface class.
+
+    Sorted Set that has tuples of timestamps and values.
+    """

esmf_aspect_meta_model_python/base/characteristics/either.py

@@ -0,0 +1,31 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+
+from esmf_aspect_meta_model_python.base.characteristics.characteristic import Characteristic
+
+
+class Either(Characteristic, ABC):
+    """Either interface class.
+
+    Describes a property that has exactly one of two possible values.
+    """
+
+    @property
+    @abstractmethod
+    def left(self) -> Characteristic:
+        """Left."""
+
+    @property
+    @abstractmethod
+    def right(self) -> Characteristic:
+        """Right."""

esmf_aspect_meta_model_python/base/characteristics/enumeration.py

@@ -0,0 +1,27 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC, abstractmethod
+from typing import List
+
+from esmf_aspect_meta_model_python.base.characteristics.characteristic import Characteristic
+
+
+class Enumeration(Characteristic, ABC):
+    """Enumeration interface class.
+
+    Describes a Property that has exactly one of multiple possible values.
+    """
+
+    @property
+    @abstractmethod
+    def values(self) -> List:
+        """Values."""

esmf_aspect_meta_model_python/base/characteristics/quantifiable/__init__.py

@@ -0,0 +1,10 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0

esmf_aspect_meta_model_python/base/characteristics/quantifiable/duration.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.quantifiable.quantifiable import Quantifiable
+
+
+class Duration(Quantifiable, ABC):
+    """Duration interface class.
+
+    Quantifiable where the unit quantifies time.
+    """

esmf_aspect_meta_model_python/base/characteristics/quantifiable/measurement.py

@@ -0,0 +1,21 @@
+#  Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
+#
+#  See the AUTHORS file(s) distributed with this work for additional
+#  information regarding authorship.
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+#   SPDX-License-Identifier: MPL-2.0
+
+from abc import ABC
+
+from esmf_aspect_meta_model_python.base.characteristics.quantifiable.quantifiable import Quantifiable
+
+
+class Measurement(Quantifiable, ABC):
+    """Measurement interface class.
+
+    Quantifiable where the unit is required.
+    """