armodel 1.8.7__py3-none-any.whl → 1.9.2__py3-none-any.whl

armodel/models/M2/AUTOSARTemplates/SystemTemplate/RteEventToOsTaskMapping.py

@@ -1,35 +1,43 @@
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-
-
-class AppOsTaskProxyToEcuTaskProxyMapping(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.appTaskProxyRef = None                         # type: RefType
-        self.ecuTaskProxyRef = None                         # type: RefType
-        self.offset = None                                  # type: RefType
-
-    def getAppTaskProxyRef(self):
-        return self.appTaskProxyRef
-
-    def setAppTaskProxyRef(self, value):
-        if value is not None:
-            self.appTaskProxyRef = value
-        return self
-
-    def getEcuTaskProxyRef(self):
-        return self.ecuTaskProxyRef
-
-    def setEcuTaskProxyRef(self, value):
-        if value is not None:
-            self.ecuTaskProxyRef = value
-        return self
-
-    def getOffset(self):
-        return self.offset
-
-    def setOffset(self, value):
-        if value is not None:
-            self.offset = value
-        return self
+# This module contains AUTOSAR System Template classes for RTE event to OS task mapping
+# It defines mappings between application and ECU task proxies for real-time execution
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class AppOsTaskProxyToEcuTaskProxyMapping(Identifiable):
+    """
+    Represents a mapping between application OS task proxies and ECU task proxies
+    in the Runtime Environment (RTE), defining how application-level tasks are
+    connected to ECU-level tasks for real-time execution coordination.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.appTaskProxyRef: RefType = None
+        self.ecuTaskProxyRef: RefType = None
+        self.offset: RefType = None
+
+    def getAppTaskProxyRef(self):
+        return self.appTaskProxyRef
+
+    def setAppTaskProxyRef(self, value):
+        if value is not None:
+            self.appTaskProxyRef = value
+        return self
+
+    def getEcuTaskProxyRef(self):
+        return self.ecuTaskProxyRef
+
+    def setEcuTaskProxyRef(self, value):
+        if value is not None:
+            self.ecuTaskProxyRef = value
+        return self
+
+    def getOffset(self):
+        return self.offset
+
+    def setOffset(self, value):
+        if value is not None:
+            self.offset = value
+        return self

armodel/models/M2/AUTOSARTemplates/SystemTemplate/SWmapping.py

@@ -1,52 +1,65 @@
-from typing import List
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from ....M2.AUTOSARTemplates.SystemTemplate.InstanceRefs import ComponentInSystemInstanceRef
-
-
-class SwcToImplMapping(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.componentIRefs = []                                    # type: List[ComponentInSystemInstanceRef]
-        self.componentImplementationRef = None                      # type: RefType
-
-    def getComponentIRefs(self):
-        return self.componentIRefs
-
-    def addComponentIRef(self, value):
-        if value is not None:
-            self.componentIRefs.append(value)
-        return self
-
-    def getComponentImplementationRef(self):
-        return self.componentImplementationRef
-
-    def setComponentImplementationRef(self, value):
-        if value is not None:
-            self.componentImplementationRef = value
-        return self
-
-
-class ApplicationPartitionToEcuPartitionMapping(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.applicationPartitionRefs = []                      # type: List[RefType]
-        self.ecuPartitionRef = None                             # type: RefType
-
-    def getApplicationPartitionRefs(self):
-        return self.applicationPartitionRefs
-
-    def addApplicationPartitionRef(self, value):
-        if value is not None:
-            self.applicationPartitionRefs.append(value)
-        return self
-
-    def getEcuPartitionRef(self):
-        return self.ecuPartitionRef
-
-    def setEcuPartitionRef(self, value):
-        if value is not None:
-            self.ecuPartitionRef = value
-        return self
+# This module contains AUTOSAR System Template classes for software component mapping
+# It defines mappings between software components and their implementations or partitions
+
+from typing import List
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.SystemTemplate.InstanceRefs import ComponentInSystemInstanceRef
+
+
+class SwcToImplMapping(Identifiable):
+    """
+    Represents a mapping between software components and their implementations,
+    defining how software component instances in the system are connected to
+    their specific implementation references and instance references.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.componentIRefs: List[ComponentInSystemInstanceRef] = []
+        self.componentImplementationRef: RefType = None
+
+    def getComponentIRefs(self):
+        return self.componentIRefs
+
+    def addComponentIRef(self, value):
+        if value is not None:
+            self.componentIRefs.append(value)
+        return self
+
+    def getComponentImplementationRef(self):
+        return self.componentImplementationRef
+
+    def setComponentImplementationRef(self, value):
+        if value is not None:
+            self.componentImplementationRef = value
+        return self
+
+
+class ApplicationPartitionToEcuPartitionMapping(Identifiable):
+    """
+    Represents a mapping between application partitions and ECU partitions,
+    defining how application-level partitions are mapped to ECU-level
+    partitions for resource allocation and execution management.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.applicationPartitionRefs: List[RefType] = []
+        self.ecuPartitionRef: RefType = None
+
+    def getApplicationPartitionRefs(self):
+        return self.applicationPartitionRefs
+
+    def addApplicationPartitionRef(self, value):
+        if value is not None:
+            self.applicationPartitionRefs.append(value)
+        return self
+
+    def getEcuPartitionRef(self):
+        return self.ecuPartitionRef
+
+    def setEcuPartitionRef(self, value):
+        if value is not None:
+            self.ecuPartitionRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/SystemTemplate/SecureCommunication.py

@@ -1,83 +1,105 @@
-from typing import List
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Boolean, RefType
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-
-
-class CryptoServiceMapping(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-
-class SecOcCryptoServiceMapping(CryptoServiceMapping):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.authenticationRef = None                           # type: RefType
-        self.cryptoServiceKeyRef = None                         # type: RefType
-        self.cryptoServiceQueueRef = None                       # type: RefType
-
-    def getAuthenticationRef(self):
-        return self.authenticationRef
-
-    def setAuthenticationRef(self, value):
-        if value is not None:
-            self.authenticationRef = value
-        return self
-
-    def getCryptoServiceKeyRef(self):
-        return self.cryptoServiceKeyRef
-
-    def setCryptoServiceKeyRef(self, value):
-        if value is not None:
-            self.cryptoServiceKeyRef = value
-        return self
-
-    def getCryptoServiceQueueRef(self):
-        return self.cryptoServiceQueueRef
-
-    def setCryptoServiceQueueRef(self, value):
-        if value is not None:
-            self.cryptoServiceQueueRef = value
-        return self
-
-
-class TlsCryptoServiceMapping(CryptoServiceMapping):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.keyExchangeRef = None                                  # type: RefType
-        self.tlsCipherSuites = []                                   # type: List[TlsCryptoCipherSuite]
-        self.useClientAuthenticationRequest = None                  # type: Boolean
-        self.useSecurityExtensionRecordSizeLimit = None             # type: Boolean
-
-    def getKeyExchangeRef(self):
-        return self.keyExchangeRef
-
-    def setKeyExchangeRef(self, value):
-        if value is not None:
-            self.keyExchangeRef = value
-        return self
-
-    def getTlsCipherSuites(self):
-        return self.tlsCipherSuites
-
-    def addTlsCipherSuite(self, value):
-        if value is not None:
-            self.tlsCipherSuites.append(value)
-        return self
-
-    def getUseClientAuthenticationRequest(self):
-        return self.useClientAuthenticationRequest
-
-    def setUseClientAuthenticationRequest(self, value):
-        if value is not None:
-            self.useClientAuthenticationRequest = value
-        return self
-
-    def getUseSecurityExtensionRecordSizeLimit(self):
-        return self.useSecurityExtensionRecordSizeLimit
-
-    def setUseSecurityExtensionRecordSizeLimit(self, value):
-        if value is not None:
-            self.useSecurityExtensionRecordSizeLimit = value
-        return self
+# This module contains AUTOSAR System Template classes for secure communication
+# It defines crypto service mappings and TLS configurations for secure data transmission
+
+from typing import List
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Boolean, RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class CryptoServiceMapping(Identifiable, ABC):
+    """
+    Abstract base class for crypto service mappings, defining
+    common properties for different types of cryptographic
+    service mappings in the AUTOSAR system.
+    """
+
+    def __init__(self, parent, short_name):
+        if type(self) is CryptoServiceMapping:
+            raise TypeError("CryptoServiceMapping is an abstract class.")
+        super().__init__(parent, short_name)
+
+
+class SecOcCryptoServiceMapping(CryptoServiceMapping):
+    """
+    Represents a Secure Onboard Communication (SecOC) crypto service mapping,
+    defining authentication, key, and queue references for secure
+    communication between ECUs.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.authenticationRef: RefType = None
+        self.cryptoServiceKeyRef: RefType = None
+        self.cryptoServiceQueueRef: RefType = None
+
+    def getAuthenticationRef(self):
+        return self.authenticationRef
+
+    def setAuthenticationRef(self, value):
+        if value is not None:
+            self.authenticationRef = value
+        return self
+
+    def getCryptoServiceKeyRef(self):
+        return self.cryptoServiceKeyRef
+
+    def setCryptoServiceKeyRef(self, value):
+        if value is not None:
+            self.cryptoServiceKeyRef = value
+        return self
+
+    def getCryptoServiceQueueRef(self):
+        return self.cryptoServiceQueueRef
+
+    def setCryptoServiceQueueRef(self, value):
+        if value is not None:
+            self.cryptoServiceQueueRef = value
+        return self
+
+
+class TlsCryptoServiceMapping(CryptoServiceMapping):
+    """
+    Represents a TLS (Transport Layer Security) crypto service mapping,
+    defining key exchange references, cipher suites, and authentication
+    settings for TLS-secured communication.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.keyExchangeRef: RefType = None
+        self.tlsCipherSuites: List = []
+        self.useClientAuthenticationRequest: Boolean = None
+        self.useSecurityExtensionRecordSizeLimit: Boolean = None
+
+    def getKeyExchangeRef(self):
+        return self.keyExchangeRef
+
+    def setKeyExchangeRef(self, value):
+        if value is not None:
+            self.keyExchangeRef = value
+        return self
+
+    def getTlsCipherSuites(self):
+        return self.tlsCipherSuites
+
+    def addTlsCipherSuite(self, value):
+        if value is not None:
+            self.tlsCipherSuites.append(value)
+        return self
+
+    def getUseClientAuthenticationRequest(self):
+        return self.useClientAuthenticationRequest
+
+    def setUseClientAuthenticationRequest(self, value):
+        if value is not None:
+            self.useClientAuthenticationRequest = value
+        return self
+
+    def getUseSecurityExtensionRecordSizeLimit(self):
+        return self.useSecurityExtensionRecordSizeLimit
+
+    def setUseSecurityExtensionRecordSizeLimit(self, value):
+        if value is not None:
+            self.useSecurityExtensionRecordSizeLimit = value
+        return self