armodel 1.8.6__py3-none-any.whl → 1.9.1__py3-none-any.whl

armodel/models/M2/AUTOSARTemplates/CommonStructure/__init__.py

@@ -1,205 +1,17 @@
-from abc import ABCMeta
-from typing import List
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARNumerical, RefType
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral
-
-
-class ValueSpecification(ARObject, metaclass=ABCMeta):
-    '''
-    Base class for expressions leading to a value which can be used to initialize a data object.
-
-    Base        : ARObject
-    Subclasses  : AbstractRuleBasedValueSpecification, ApplicationValueSpecification, CompositeValueSpecification,
-                  ConstantReference, NotAvailableValueSpecification, NumericalValueSpecification, ReferenceValueSpecification,
-                  TextValueSpecification
-    '''
-
-    def __init__(self):
-        if type(self) is ValueSpecification:
-            raise NotImplementedError(
-                "ValueSpecification is an abstract class.")
-
-        super().__init__()
-
-        self.shortLabel = None
-
-    def getShortLabel(self):
-        return self.shortLabel
-
-    def setShortLabel(self, value):
-        self.shortLabel = value
-        return self
-
-
-class CompositeValueSpecification(ValueSpecification, metaclass=ABCMeta):
-    '''
-    This abstract meta-class acts a base class for ValueSpecifications that have a composite form.
-
-    Base        : ARObject, ValueSpecification
-    Subclasses  : ArrayValueSpecification, RecordValueSpecification
-    '''
-
-    def __init__(self):
-        if type(self) is CompositeValueSpecification:
-            raise NotImplementedError(
-                "CompositeValueSpecification is an abstract class.")
-
-        super().__init__()
-
-
-class CompositeRuleBasedValueArgument(ARObject, metaclass=ABCMeta):
-    '''
-    This meta-class has the ability to serve as the abstract base class for ValueSpecifications that can be
-    used for compound primitive data types.
-
-    Base        : ARObject
-    Subclasses  : ApplicationRuleBasedValueSpecification, ApplicationValueSpecification
-    '''
-
-    def __init__(self):
-        if type(self) is CompositeRuleBasedValueArgument:
-            raise NotImplementedError(
-                "CompositeRuleBasedValueArgument is an abstract class.")
-
-        super().__init__()
-
-
-class ApplicationValueSpecification(CompositeRuleBasedValueArgument, ValueSpecification):
-    '''
-    This meta-class represents values for DataPrototypes typed by ApplicationDataTypes (this includes in
-    particular compound primitives).
-    For further details refer to ASAM CDF 2.0. This meta-class corresponds to some extent with
-    SW-INSTANCE in ASAM CDF 2.0.
-
-    Base ARObject, CompositeRuleBasedValueArgument, ValueSpecification
-    '''
-
-    def __init__(self):
-
-        CompositeRuleBasedValueArgument.__init__(self)
-        ValueSpecification.__init__(self)
-
-        self.category = None
-        self.swAxisCont = []
-        self.swValueCont = None
-
-    def getCategory(self):
-        return self.category
-
-    def setCategory(self, value):
-        self.category = value
-        return self
-
-    def getSwAxisCont(self):
-        return self.swAxisCont
-
-    def setSwAxisCont(self, value):
-        self.swAxisCont = value
-        return self
-
-    def getSwValueCont(self):
-        return self.swValueCont
-
-    def setSwValueCont(self, value):
-        self.swValueCont = value
-        return self
-
-
-class RecordValueSpecification(CompositeValueSpecification):
-    '''
-    Specifies the values for a record.
-
-    Base : ARObject, CompositeValueSpecification, ValueSpecification
-    '''
-
-    def __init__(self):
-        super().__init__()
-
-        self.fields = []
-
-    def addField(self, field: ValueSpecification):
-        self.fields.append(field)
-
-    def getFields(self) -> List[ValueSpecification]:
-        return self.fields
-
-
-class TextValueSpecification(ValueSpecification):
-    def __init__(self):
-        super().__init__()
-
-        self.value = None               # type: ARLiteral
-
-    def getValue(self):
-        return self.value
-
-    def setValue(self, value):
-        self.value = value
-        return self
-
-
-class NumericalValueSpecification(ValueSpecification):
-    def __init__(self):
-        super().__init__()
-
-        self.value: ARNumerical = None
-
-    def getValue(self) -> ARNumerical:
-        return self.value
-
-    def setValue(self, value: ARNumerical):
-        if value is not None:
-            self.value = value
-        return self
-
-
-class ArrayValueSpecification(ValueSpecification):
-    def __init__(self):
-        super().__init__()
-
-        # type: List[ValueSpecification]
-        self.element = []
-        self.intendedPartialInitializationCount = None
-
-    def getIntendedPartialInitializationCount(self):
-        return self.intendedPartialInitializationCount
-
-    def setIntendedPartialInitializationCount(self, value):
-        self.intendedPartialInitializationCount = value
-        return self
-
-    def addElement(self, element: ValueSpecification):
-        self.element.append(element)
-
-    def getElements(self) -> List[ValueSpecification]:
-        return self.element
-
-
-class ConstantSpecification(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.valueSpec = None                  # type: ValueSpecification
-
-    def getValueSpec(self):
-        return self.valueSpec
-
-    def setValueSpec(self, value):
-        self.valueSpec = value
-        return self
-
-
-class ConstantReference(ValueSpecification):
-    def __init__(self):
-        super().__init__()
-
-        self.constantRef: RefType = None
-
-    def getConstantRef(self):
-        return self.constantRef
-
-    def setConstantRef(self, value):
-        self.constantRef = value
-        return self
+"""
+CommonStructure module re-exports classes from submodules for backward compatibility.
+"""
+
+# Re-export ValueSpecification classes from Constants submodule
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Constants import (
+    ValueSpecification,
+    CompositeValueSpecification,
+    CompositeRuleBasedValueArgument,
+    ApplicationValueSpecification,
+    RecordValueSpecification,
+    TextValueSpecification,
+    NumericalValueSpecification,
+    ArrayValueSpecification,
+    ConstantSpecification,
+    ConstantReference,
+)

armodel/models/M2/AUTOSARTemplates/DiagnosticExtract/DiagnosticCommonElement.py

@@ -0,0 +1,11 @@
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import (
+    ARElement,
+)
+
+
+class DiagnosticCommonElement(ARElement, ABC):
+    def __init__(self, parent, short_name: str):
+        if type(self) is DiagnosticCommonElement:
+            raise TypeError("DiagnosticCommonElement is an abstract class.")
+        super().__init__(parent, short_name)

armodel/models/M2/AUTOSARTemplates/DiagnosticExtract/DiagnosticContribution.py

@@ -1,47 +1,137 @@
-from typing import List
-
-from .....models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import NameToken, RefType
-from .....models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-
-
-class DiagnosticServiceTable(ARElement):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.diagnosticConnectionRefs = []                              # type: List[RefType]
-        self.diagnosticServiceInstanceRefs = []                         # type: List[RefType]
-        self.ecuInstanceRef = None                                      # type: RefType
-        self.protocolKind = None                                        # type: NameToken
-
-    def getDiagnosticConnectionRefs(self):
-        return self.diagnosticConnectionRefs
-
-    def addDiagnosticConnectionRef(self, value):
-        if value is not None:
-            self.diagnosticConnectionRefs.append(value)
-        return self
-
-    def getDiagnosticServiceInstanceRefs(self):
-        return self.diagnosticServiceInstanceRefs
-
-    def addDiagnosticServiceInstanceRef(self, value):
-        if value is not None:
-            self.diagnosticServiceInstanceRefs.append(value)
-        return self
-
-    def getEcuInstanceRef(self):
-        return self.ecuInstanceRef
-
-    def setEcuInstanceRef(self, value):
-        if value is not None:
-            self.ecuInstanceRef = value
-        return self
-
-    def getProtocolKind(self):
-        return self.protocolKind
-
-    def setProtocolKind(self, value):
-        if value is not None:
-            self.protocolKind = value
-        return self
+"""
+This module contains classes for representing AUTOSAR diagnostic service contributions
+in the DiagnosticExtract module.
+"""
+
+from typing import List, Optional
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import (
+    NameToken,
+    RefType,
+)
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import (
+    ARObject,
+)
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import (
+    ARElement,
+)
+from armodel.models.M2.AUTOSARTemplates.DiagnosticExtract.DiagnosticCommonElement import DiagnosticCommonElement
+
+
+class DiagnosticServiceTable(DiagnosticCommonElement):
+    """
+    Represents a diagnostic service table in AUTOSAR diagnostic extract.
+    This class defines the relationship between diagnostic connections,
+    service instances, and ECU instances for specific protocols.
+    """
+
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the DiagnosticServiceTable with a parent and short name.
+
+        Args:
+            parent: The parent ARObject that contains this diagnostic service table
+            short_name: The unique short name of this diagnostic service table
+        """
+        super().__init__(parent, short_name)
+
+        self.diagnosticConnectionRefs: List[RefType] = []
+        self.diagnosticServiceInstanceRefs: List[RefType] = []
+        self.ecuInstanceRef: Optional[RefType] = None
+        self.protocolKind: Optional[NameToken] = None
+
+    def getDiagnosticConnectionRefs(self) -> List[RefType]:
+        """
+        Gets the list of diagnostic connection references for this service table.
+
+        Returns:
+            List of RefType instances representing diagnostic connection references
+        """
+        return self.diagnosticConnectionRefs
+
+    def addDiagnosticConnectionRef(self, value: RefType):
+        """
+        Adds a diagnostic connection reference to this service table.
+        Only adds the value if it is not None.
+
+        Args:
+            value: The diagnostic connection reference to add
+
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.diagnosticConnectionRefs.append(value)
+        return self
+
+    def getDiagnosticServiceInstanceRefs(self) -> List[RefType]:
+        """
+        Gets the list of diagnostic service instance references for this service table.
+
+        Returns:
+            List of RefType instances representing diagnostic service instance references
+        """
+        return self.diagnosticServiceInstanceRefs
+
+    def addDiagnosticServiceInstanceRef(self, value: RefType):
+        """
+        Adds a diagnostic service instance reference to this service table.
+        Only adds the value if it is not None.
+
+        Args:
+            value: The diagnostic service instance reference to add
+
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.diagnosticServiceInstanceRefs.append(value)
+        return self
+
+    def getEcuInstanceRef(self) -> Optional[RefType]:
+        """
+        Gets the ECU instance reference for this service table.
+
+        Returns:
+            RefType representing the ECU instance reference, or None if not set
+        """
+        return self.ecuInstanceRef
+
+    def setEcuInstanceRef(self, value: RefType):
+        """
+        Sets the ECU instance reference for this service table.
+        Only sets the value if it is not None.
+
+        Args:
+            value: The ECU instance reference to set
+
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.ecuInstanceRef = value
+        return self
+
+    def getProtocolKind(self) -> Optional[NameToken]:
+        """
+        Gets the protocol kind for this service table.
+
+        Returns:
+            NameToken representing the protocol kind, or None if not set
+        """
+        return self.protocolKind
+
+    def setProtocolKind(self, value: NameToken):
+        """
+        Sets the protocol kind for this service table.
+        Only sets the value if it is not None.
+
+        Args:
+            value: The protocol kind to set
+
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.protocolKind = value
+        return self

armodel/models/M2/AUTOSARTemplates/DiagnosticExtract/__init__.py

@@ -0,0 +1,10 @@
+"""
+This package contains classes for representing AUTOSAR diagnostic extract templates.
+
+Diagnostic extracts define the relationship between diagnostic services, connections,
+and ECU instances for specific protocols. This module provides the core structures
+needed to represent diagnostic information in AUTOSAR models.
+
+Classes:
+    DiagnosticServiceTable - Represents a diagnostic service table with connections and service instances
+"""