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

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/EndToEndProtection.py

@@ -1,184 +1,191 @@
-from ..GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ..GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ..GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Integer, NameToken, PositiveInteger, RefType
-from ..SystemTemplate.InstanceRefs import VariableDataPrototypeInSystemInstanceRef
-from typing import List
-
-
-class EndToEndDescription(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.category = None                # type: NameToken
-        self.counterOffset = None           # type: PositiveInteger
-        self.crcOffset = None               # type: PositiveInteger
-        self.dataIds = []                   # type: List[PositiveInteger]
-        self.dataIdMode = None              # type: PositiveInteger
-        self.dataIdNibbleOffset = None      # type: PositiveInteger
-        self.dataLength = None              # type: PositiveInteger
-        self.maxDeltaCounterInit = None     # type: PositiveInteger
-        self.maxNoNewOrRepeatedData = None  # type: int
-        self.syncCounterInit = None         # type: PositiveInteger
-
-    def getCategory(self):
-        return self.category
-
-    def setCategory(self, value):
-        self.category = value
-        return self
-
-    def getCounterOffset(self):
-        return self.counterOffset
-
-    def setCounterOffset(self, value):
-        self.counterOffset = value
-        return self
-
-    def getCrcOffset(self):
-        return self.crcOffset
-
-    def setCrcOffset(self, value):
-        self.crcOffset = value
-        return self
-
-    def getDataIds(self) -> List[PositiveInteger]:
-        # return sorted(self.dataIds, key = lambda a: a.getValue())
-        return self.dataIds
-
-    def addDataId(self, id: PositiveInteger):
-        self.dataIds.append(id)
-        return self
-
-    def getDataIdMode(self):
-        return self.dataIdMode
-
-    def setDataIdMode(self, value):
-        self.dataIdMode = value
-        return self
-
-    def getDataIdNibbleOffset(self):
-        return self.dataIdNibbleOffset
-
-    def setDataIdNibbleOffset(self, value):
-        self.dataIdNibbleOffset = value
-        return self
-
-    def getDataLength(self):
-        return self.dataLength
-
-    def setDataLength(self, value):
-        self.dataLength = value
-        return self
-
-    def getMaxDeltaCounterInit(self):
-        return self.maxDeltaCounterInit
-
-    def setMaxDeltaCounterInit(self, value):
-        self.maxDeltaCounterInit = value
-        return self
-
-    def getMaxNoNewOrRepeatedData(self):
-        return self.maxNoNewOrRepeatedData
-
-    def setMaxNoNewOrRepeatedData(self, value):
-        self.maxNoNewOrRepeatedData = value
-        return self
-
-    def getSyncCounterInit(self):
-        return self.syncCounterInit
-
-    def setSyncCounterInit(self, value):
-        self.syncCounterInit = value
-        return self
-
-
-class EndToEndProtectionVariablePrototype(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self._receiverIRefs = []            # type: List[VariableDataPrototypeInSystemInstanceRef]
-        self.senderIRef = None             # type: VariableDataPrototypeInSystemInstanceRef
-        self.shortLabel = None              # type: str
-
-    def addReceiverIref(self, iref: VariableDataPrototypeInSystemInstanceRef):
-        self._receiverIRefs.append(iref)
-
-    def getReceiverIrefs(self) -> List[VariableDataPrototypeInSystemInstanceRef]:
-        return self._receiverIRefs
-
-
-class EndToEndProtectionISignalIPdu(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.dataOffset = None                              # type: Integer
-        self.iSignalGroupRef = None                         # type: RefType
-        self.iSignalIPduRef = None                          # type: RefType
-
-    def getDataOffset(self):
-        return self.dataOffset
-
-    def setDataOffset(self, value):
-        self.dataOffset = value
-        return self
-
-    def getISignalGroupRef(self):
-        return self.iSignalGroupRef
-
-    def setISignalGroupRef(self, value):
-        self.iSignalGroupRef = value
-        return self
-
-    def getISignalIPduRef(self):
-        return self.iSignalIPduRef
-
-    def setISignalIPduRef(self, value):
-        self.iSignalIPduRef = value
-        return self
-
-
-class EndToEndProtection(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.endToEndProfile = None                         # type: EndToEndDescription
-        self.endToEndProtectionISignalIPdus = []            # type: List[EndToEndProtectionISignalIPdu]
-        self.endToEndProtectionVariablePrototypes = []      # type: List[EndToEndProtectionVariablePrototype]
-
-    def getEndToEndProfile(self):
-        return self.endToEndProfile
-
-    def setEndToEndProfile(self, value):
-        if value is not None:
-            self.endToEndProfile = value
-        return self
-
-    def getEndToEndProtectionISignalIPdus(self):
-        return self.endToEndProtectionISignalIPdus
-
-    def addEndToEndProtectionISignalIPdu(self, value):
-        if value is not None:
-            self.endToEndProtectionISignalIPdus.append(value)
-        return self
-
-    def getEndToEndProtectionVariablePrototypes(self) -> List[EndToEndProtectionVariablePrototype]:
-        return self.endToEndProtectionVariablePrototypes
-    
-    def addEndToEndProtectionVariablePrototype(self, value: EndToEndProtectionVariablePrototype):
-        if value is not None:
-            self.endToEndProtectionVariablePrototypes.append(value)
-        return self
-
-
-class EndToEndProtectionSet(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-    def createEndToEndProtection(self, short_name: str) -> EndToEndProtection:
-        if not self.IsElementExists(short_name):
-            protection = EndToEndProtection(self, short_name)
-            self.addElement(protection)
-        return self.getElement(short_name, EndToEndProtection)
-
-    def getEndToEndProtections(self) -> List[EndToEndProtection]:
-        return sorted(filter(lambda c: isinstance(c, EndToEndProtection), self.elements), key=lambda e: e.short_name)
+"""
+This module contains classes for representing AUTOSAR end-to-end protection
+mechanisms in the SWComponentTemplate module. It includes classes for
+defining end-to-end protection profiles, variables, and protection sets
+used to ensure data integrity in communication systems.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable, ARElement
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Integer, NameToken, PositiveInteger, RefType
+from armodel.models.M2.AUTOSARTemplates.SystemTemplate.InstanceRefs import VariableDataPrototypeInSystemInstanceRef
+from typing import List
+
+
+class EndToEndDescription(ARObject):
+    def __init__(self):
+        super().__init__()
+
+        self.category: NameToken = None
+        self.counterOffset: PositiveInteger = None
+        self.crcOffset: PositiveInteger = None
+        self.dataIds: List[PositiveInteger] = []
+        self.dataIdMode: PositiveInteger = None
+        self.dataIdNibbleOffset: PositiveInteger = None
+        self.dataLength: PositiveInteger = None
+        self.maxDeltaCounterInit: PositiveInteger = None
+        self.maxNoNewOrRepeatedData: int = None
+        self.syncCounterInit: PositiveInteger = None
+
+    def getCategory(self):
+        return self.category
+
+    def setCategory(self, value):
+        self.category = value
+        return self
+
+    def getCounterOffset(self):
+        return self.counterOffset
+
+    def setCounterOffset(self, value):
+        self.counterOffset = value
+        return self
+
+    def getCrcOffset(self):
+        return self.crcOffset
+
+    def setCrcOffset(self, value):
+        self.crcOffset = value
+        return self
+
+    def getDataIds(self) -> List[PositiveInteger]:
+        # return sorted(self.dataIds, key = lambda a: a.getValue())
+        return self.dataIds
+
+    def addDataId(self, id: PositiveInteger):
+        self.dataIds.append(id)
+        return self
+
+    def getDataIdMode(self):
+        return self.dataIdMode
+
+    def setDataIdMode(self, value):
+        self.dataIdMode = value
+        return self
+
+    def getDataIdNibbleOffset(self):
+        return self.dataIdNibbleOffset
+
+    def setDataIdNibbleOffset(self, value):
+        self.dataIdNibbleOffset = value
+        return self
+
+    def getDataLength(self):
+        return self.dataLength
+
+    def setDataLength(self, value):
+        self.dataLength = value
+        return self
+
+    def getMaxDeltaCounterInit(self):
+        return self.maxDeltaCounterInit
+
+    def setMaxDeltaCounterInit(self, value):
+        self.maxDeltaCounterInit = value
+        return self
+
+    def getMaxNoNewOrRepeatedData(self):
+        return self.maxNoNewOrRepeatedData
+
+    def setMaxNoNewOrRepeatedData(self, value):
+        self.maxNoNewOrRepeatedData = value
+        return self
+
+    def getSyncCounterInit(self):
+        return self.syncCounterInit
+
+    def setSyncCounterInit(self, value):
+        self.syncCounterInit = value
+        return self
+
+
+class EndToEndProtectionVariablePrototype(ARObject):
+    def __init__(self):
+        super().__init__()
+
+        self._receiverIRefs: List[VariableDataPrototypeInSystemInstanceRef] = []
+        self.senderIRef: VariableDataPrototypeInSystemInstanceRef = None
+        self.shortLabel: str = None
+
+    def addReceiverIref(self, iref: VariableDataPrototypeInSystemInstanceRef):
+        self._receiverIRefs.append(iref)
+
+    def getReceiverIrefs(self) -> List[VariableDataPrototypeInSystemInstanceRef]:
+        return self._receiverIRefs
+
+
+class EndToEndProtectionISignalIPdu(ARObject):
+    def __init__(self):
+        super().__init__()
+
+        self.dataOffset: Integer = None
+        self.iSignalGroupRef: RefType = None
+        self.iSignalIPduRef: RefType = None
+
+    def getDataOffset(self):
+        return self.dataOffset
+
+    def setDataOffset(self, value):
+        self.dataOffset = value
+        return self
+
+    def getISignalGroupRef(self):
+        return self.iSignalGroupRef
+
+    def setISignalGroupRef(self, value):
+        self.iSignalGroupRef = value
+        return self
+
+    def getISignalIPduRef(self):
+        return self.iSignalIPduRef
+
+    def setISignalIPduRef(self, value):
+        self.iSignalIPduRef = value
+        return self
+
+
+class EndToEndProtection(Identifiable):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.endToEndProfile: EndToEndDescription = None
+        self.endToEndProtectionISignalIPdus: List[EndToEndProtectionISignalIPdu] = []
+        self.endToEndProtectionVariablePrototypes: List[EndToEndProtectionVariablePrototype] = []
+
+    def getEndToEndProfile(self):
+        return self.endToEndProfile
+
+    def setEndToEndProfile(self, value):
+        if value is not None:
+            self.endToEndProfile = value
+        return self
+
+    def getEndToEndProtectionISignalIPdus(self):
+        return self.endToEndProtectionISignalIPdus
+
+    def addEndToEndProtectionISignalIPdu(self, value):
+        if value is not None:
+            self.endToEndProtectionISignalIPdus.append(value)
+        return self
+
+    def getEndToEndProtectionVariablePrototypes(self) -> List[EndToEndProtectionVariablePrototype]:
+        return self.endToEndProtectionVariablePrototypes
+    
+    def addEndToEndProtectionVariablePrototype(self, value: EndToEndProtectionVariablePrototype):
+        if value is not None:
+            self.endToEndProtectionVariablePrototypes.append(value)
+        return self
+
+
+class EndToEndProtectionSet(ARElement):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+    def createEndToEndProtection(self, short_name: str) -> EndToEndProtection:
+        if not self.IsElementExists(short_name):
+            protection = EndToEndProtection(self, short_name)
+            self.addElement(protection)
+        return self.getElement(short_name, EndToEndProtection)
+
+    def getEndToEndProtections(self) -> List[EndToEndProtection]:
+        return sorted(filter(lambda c: isinstance(c, EndToEndProtection), self.elements), key=lambda e: e.short_name)

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/PortInterface/InstanceRefs.py

@@ -1,39 +1,45 @@
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from .....M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpInstanceRef
-
-class ApplicationCompositeElementInPortInterfaceInstanceRef(AtpInstanceRef):
-    def __init__(self):
-        super().__init__()
-
-        self.baseRef = None                                         # type: RefType
-        self.contextDataPrototypeRef = None                         # type: RefType
-        self.rootDataPrototypeRef = None                            # type: RefType
-        self.targetDataPrototypeRef = None                          # type: RefType
-
-    def getBaseRef(self):
-        return self.baseRef
-
-    def setBaseRef(self, value):
-        self.baseRef = value
-        return self
-
-    def getContextDataPrototypeRef(self):
-        return self.contextDataPrototypeRef
-
-    def setContextDataPrototypeRef(self, value):
-        self.contextDataPrototypeRef = value
-        return self
-
-    def getRootDataPrototypeRef(self):
-        return self.rootDataPrototypeRef
-
-    def setRootDataPrototypeRef(self, value):
-        self.rootDataPrototypeRef = value
-        return self
-
-    def getTargetDataPrototypeRef(self):
-        return self.targetDataPrototypeRef
-
-    def setTargetDataPrototypeRef(self, value):
-        self.targetDataPrototypeRef = value
-        return self
+"""
+This module contains classes for representing AUTOSAR instance references
+in port interface contexts. These classes are used for referencing data
+elements within port interfaces and compositions.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpInstanceRef
+
+class ApplicationCompositeElementInPortInterfaceInstanceRef(AtpInstanceRef):
+    def __init__(self):
+        super().__init__()
+
+        self.baseRef: RefType = None
+        self.contextDataPrototypeRef: RefType = None
+        self.rootDataPrototypeRef: RefType = None
+        self.targetDataPrototypeRef: RefType = None
+
+    def getBaseRef(self):
+        return self.baseRef
+
+    def setBaseRef(self, value):
+        self.baseRef = value
+        return self
+
+    def getContextDataPrototypeRef(self):
+        return self.contextDataPrototypeRef
+
+    def setContextDataPrototypeRef(self, value):
+        self.contextDataPrototypeRef = value
+        return self
+
+    def getRootDataPrototypeRef(self):
+        return self.rootDataPrototypeRef
+
+    def setRootDataPrototypeRef(self, value):
+        self.rootDataPrototypeRef = value
+        return self
+
+    def getTargetDataPrototypeRef(self):
+        return self.targetDataPrototypeRef
+
+    def setTargetDataPrototypeRef(self, value):
+        self.targetDataPrototypeRef = value
+        return self