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

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/SwcInternalBehavior/PortAPIOptions.py

@@ -1,86 +1,91 @@
-from .....M2.AUTOSARTemplates.CommonStructure import ValueSpecification
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARBoolean, RefType, TRefType
-from typing import List
-
-class PortDefinedArgumentValue(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.value = None                       # type: ValueSpecification
-        self.valueTypeTRef = None               # type: TRefType
-
-    def getValue(self):
-        return self.value
-
-    def setValue(self, value):
-        self.value = value
-        return self
-
-    def getValueTypeTRef(self):
-        return self.valueTypeTRef
-
-    def setValueTypeTRef(self, value):
-        self.valueTypeTRef = value
-        return self
-
-class PortAPIOption(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.enableTakeAddress = None               # type: ARBoolean
-        self.errorHandling = None                   # type: DataTransformationErrorHandlingEnum
-        self.indirectAPI = None                     # type: ARBoolean
-        self.portRef = None                         # type: RefType
-        self.portArgValues = []                     # type: List[PortDefinedArgumentValue]
-        self.supportedFeatures = []                 # type: List[SwcSupportedFeature]
-        self.transformerStatusForwarding = None     # type: DataTransformationStatusForwardingEnum
-
-    def getEnableTakeAddress(self):
-        return self.enableTakeAddress
-
-    def setEnableTakeAddress(self, value):
-        self.enableTakeAddress = value
-        return self
-
-    def getErrorHandling(self):
-        return self.errorHandling
-
-    def setErrorHandling(self, value):
-        self.errorHandling = value
-        return self
-
-    def getIndirectAPI(self):
-        return self.indirectAPI
-
-    def setIndirectAPI(self, value):
-        self.indirectAPI = value
-        return self
-
-    def getPortRef(self):
-        return self.portRef
-
-    def setPortRef(self, value):
-        self.portRef = value
-        return self
-
-    def getPortArgValues(self):
-        return self.portArgValues
-
-    def addPortArgValue(self, value):
-        self.portArgValues.append(value)
-        return self
-
-    def getSupportedFeatures(self):
-        return self.supportedFeatures
-
-    def addSupportedFeature(self, value):
-        self.supportedFeatures.append(value)
-        return self
-
-    def getTransformerStatusForwarding(self):
-        return self.transformerStatusForwarding
-
-    def setTransformerStatusForwarding(self, value):
-        self.transformerStatusForwarding = value
-        return self
+"""
+This module contains classes for representing AUTOSAR port API options
+in software component internal behavior templates.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure import ValueSpecification
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARBoolean, RefType, TRefType
+from typing import List
+
+class PortDefinedArgumentValue(ARObject):
+    def __init__(self):
+        super().__init__()
+
+        self.value: 'ValueSpecification' = None
+        self.valueTypeTRef: 'TRefType' = None
+
+    def getValue(self):
+        return self.value
+
+    def setValue(self, value):
+        self.value = value
+        return self
+
+    def getValueTypeTRef(self):
+        return self.valueTypeTRef
+
+    def setValueTypeTRef(self, value):
+        self.valueTypeTRef = value
+        return self
+
+class PortAPIOption(ARObject):
+    def __init__(self):
+        super().__init__()
+
+        self.enableTakeAddress: ARBoolean = None
+        self.errorHandling = None
+        self.indirectAPI: ARBoolean = None
+        self.portRef: RefType = None
+        self.portArgValues: List['PortDefinedArgumentValue'] = []
+        self.supportedFeatures = []
+        self.transformerStatusForwarding = None
+
+    def getEnableTakeAddress(self):
+        return self.enableTakeAddress
+
+    def setEnableTakeAddress(self, value):
+        self.enableTakeAddress = value
+        return self
+
+    def getErrorHandling(self):
+        return self.errorHandling
+
+    def setErrorHandling(self, value):
+        self.errorHandling = value
+        return self
+
+    def getIndirectAPI(self):
+        return self.indirectAPI
+
+    def setIndirectAPI(self, value):
+        self.indirectAPI = value
+        return self
+
+    def getPortRef(self):
+        return self.portRef
+
+    def setPortRef(self, value):
+        self.portRef = value
+        return self
+
+    def getPortArgValues(self):
+        return self.portArgValues
+
+    def addPortArgValue(self, value):
+        self.portArgValues.append(value)
+        return self
+
+    def getSupportedFeatures(self):
+        return self.supportedFeatures
+
+    def addSupportedFeature(self, value):
+        self.supportedFeatures.append(value)
+        return self
+
+    def getTransformerStatusForwarding(self):
+        return self.transformerStatusForwarding
+
+    def setTransformerStatusForwarding(self, value):
+        self.transformerStatusForwarding = value
+        return self

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/SwcInternalBehavior/RTEEvents.py

@@ -1,206 +1,219 @@
-from .....M2.AUTOSARTemplates.SWComponentTemplate.Components.InstanceRefs import RVariableInAtomicSwcInstanceRef, RModeInAtomicSwcInstanceRef
-from .....M2.AUTOSARTemplates.SWComponentTemplate.Composition.InstanceRefs import POperationInAtomicSwcInstanceRef
-from .....M2.AUTOSARTemplates.CommonStructure.InternalBehavior import AbstractEvent
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType, TimeValue
-from typing import List
-
-
-class RTEEvent(AbstractEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-        
-        self.disabledModeIRefs = []                                     # type: List[RModeInAtomicSwcInstanceRef]
-        self.startOnEventRef = None                                     # type: RefType
-
-    def getDisabledModeIRefs(self):
-        return self.disabledModeIRefs
-
-    def addDisabledModeIRef(self, value):
-        self.disabledModeIRefs.append(value)
-        return self
-
-    def getStartOnEventRef(self):
-        return self.startOnEventRef
-
-    def setStartOnEventRef(self, value):
-        self.startOnEventRef = value
-        return self
-
-
-class AsynchronousServerCallReturnsEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.eventSourceRef = None                                      # type: RefType
-
-    def getEventSourceRef(self):
-        return self.eventSourceRef
-
-    def setEventSourceRef(self, value):
-        self.eventSourceRef = value
-        return self
-
-
-class DataSendCompletedEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.eventSourceRef = None                                      # type: RefType
-
-    def getEventSourceRef(self):
-        return self.eventSourceRef
-
-    def setEventSourceRef(self, value):
-        self.eventSourceRef = value
-        return self
-
-
-class DataWriteCompletedEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.eventSourceRef = None                                      # type: RefType
-
-    def getEventSourceRef(self):
-        return self.eventSourceRef
-
-    def setEventSourceRef(self, value):
-        self.eventSourceRef = value
-        return self
-
-
-class DataReceivedEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.dataIRef = None                   # type: RVariableInAtomicSwcInstanceRef
-
-    def getDataIRef(self):
-        return self.dataIRef
-
-    def setDataIRef(self, value):
-        self.dataIRef = value
-        return self
-
-
-class SwcModeSwitchEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.activation = None                                  # type: ModeActivationKind
-        self.modeIRefs: List[RModeInAtomicSwcInstanceRef] = []
-
-    def getActivation(self):
-        return self.activation
-
-    def setActivation(self, value):
-        self.activation = value
-        return self
-
-    def getModeIRefs(self):
-        return self.modeIRefs
-
-    def addModeIRef(self, value):
-        self.modeIRefs.append(value)
-        return self
-
-
-class DataReceiveErrorEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.dataIRef = None
-
-    def getDataIRef(self):
-        return self.dataIRef
-
-    def setDataIRef(self, value):
-        self.dataIRef = value
-        return self
-
-
-class OperationInvokedEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.operationIRef = None                                   # type: POperationInAtomicSwcInstanceRef
-
-    def getOperationIRef(self):
-        return self.operationIRef
-
-    def setOperationIRef(self, value):
-        if value is not None:
-            self.operationIRef = value
-        return self
-
-
-class InitEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-
-class TimingEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.offset = None                              # type: TimeValue
-        self.period = None                              # type: TimeValue
-
-    @property
-    def periodMs(self):
-        if (self.period < 0.001):
-            return self.period * 1000
-        else:
-            return (int)(self.period * 1000)
-        
-    def getOffset(self):
-        return self.offset
-
-    def setOffset(self, value):
-        if value is not None:
-            self.offset = value
-        return self
-
-    def getPeriod(self):
-        return self.period
-
-    def setPeriod(self, value):
-        if value is not None:
-            self.period = value
-        return self
-
-
-class InternalTriggerOccurredEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.eventSourceRef = None                                  # type: RefType
-
-    def getEventSourceRef(self):
-        return self.eventSourceRef
-
-    def setEventSourceRef(self, value):
-        if value is not None:
-            self.eventSourceRef = value
-        return self
-
-
-class BackgroundEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-
-class ModeSwitchedAckEvent(RTEEvent):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.eventSourceRef: RefType = None
-
-    def getEventSourceRef(self):
-        return self.eventSourceRef
-
-    def setEventSourceRef(self, value):
-        if value is not None:
-            self.eventSourceRef = value
-        return self
+"""
+This module contains classes for representing AUTOSAR RTE events
+in software component internal behavior templates.
+"""
+
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpStructureElement
+from armodel.models.M2.AUTOSARTemplates.SWComponentTemplate.Components.InstanceRefs import RVariableInAtomicSwcInstanceRef, RModeInAtomicSwcInstanceRef
+from armodel.models.M2.AUTOSARTemplates.SWComponentTemplate.Composition.InstanceRefs import POperationInAtomicSwcInstanceRef
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.InternalBehavior import AbstractEvent
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType, TimeValue
+from typing import List
+
+
+class RTEEvent(AtpStructureElement, ABC):
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is RTEEvent:
+            raise TypeError("RTEEvent is an abstract class.")
+        super().__init__(parent, short_name)
+        
+        self.disabledModeIRefs: List['RModeInAtomicSwcInstanceRef'] = []
+        self.startOnEventRef: 'RefType' = None
+
+    def getDisabledModeIRefs(self):
+        return self.disabledModeIRefs
+
+    def addDisabledModeIRef(self, value):
+        self.disabledModeIRefs.append(value)
+        return self
+
+    def getStartOnEventRef(self):
+        return self.startOnEventRef
+
+    def setStartOnEventRef(self, value):
+        self.startOnEventRef = value
+        return self
+
+
+class AsynchronousServerCallReturnsEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.eventSourceRef: 'RefType' = None
+
+    def getEventSourceRef(self):
+        return self.eventSourceRef
+
+    def setEventSourceRef(self, value):
+        self.eventSourceRef = value
+        return self
+
+
+class DataSendCompletedEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.eventSourceRef: 'RefType' = None
+
+    def getEventSourceRef(self):
+        return self.eventSourceRef
+
+    def setEventSourceRef(self, value):
+        self.eventSourceRef = value
+        return self
+
+
+class DataWriteCompletedEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.eventSourceRef: 'RefType' = None
+
+    def getEventSourceRef(self):
+        return self.eventSourceRef
+
+    def setEventSourceRef(self, value):
+        self.eventSourceRef = value
+        return self
+
+
+class DataReceivedEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.dataIRef: 'RVariableInAtomicSwcInstanceRef' = None
+
+    def getDataIRef(self):
+        return self.dataIRef
+
+    def setDataIRef(self, value):
+        self.dataIRef = value
+        return self
+
+
+class SwcModeSwitchEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.activation = None
+        self.modeIRefs: List['RModeInAtomicSwcInstanceRef'] = []
+
+    def getActivation(self):
+        return self.activation
+
+    def setActivation(self, value):
+        self.activation = value
+        return self
+
+    def getModeIRefs(self):
+        return self.modeIRefs
+
+    def addModeIRef(self, value):
+        self.modeIRefs.append(value)
+        return self
+
+
+class DataReceiveErrorEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.dataIRef: 'RVariableInAtomicSwcInstanceRef' = None
+
+    def getDataIRef(self):
+        return self.dataIRef
+
+    def setDataIRef(self, value):
+        self.dataIRef = value
+        return self
+
+
+class OperationInvokedEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.operationIRef: 'POperationInAtomicSwcInstanceRef' = None
+
+    def getOperationIRef(self):
+        return self.operationIRef
+
+    def setOperationIRef(self, value):
+        if value is not None:
+            self.operationIRef = value
+        return self
+
+
+class InitEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+
+class TimingEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.offset: 'TimeValue' = None
+        self.period: 'TimeValue' = None
+
+    @property
+    def periodMs(self):
+        if self.period is None:
+            return None
+        else:
+            period_value = self.period.getValue() if hasattr(self.period, 'getValue') else self.period
+            if period_value < 0.001:
+                return period_value * 1000
+            else:
+                return (int)(period_value * 1000)
+        
+    def getOffset(self):
+        return self.offset
+
+    def setOffset(self, value):
+        if value is not None:
+            self.offset = value
+        return self
+
+    def getPeriod(self):
+        return self.period
+
+    def setPeriod(self, value):
+        if value is not None:
+            self.period = value
+        return self
+
+
+class InternalTriggerOccurredEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.eventSourceRef: 'RefType' = None
+
+    def getEventSourceRef(self):
+        return self.eventSourceRef
+
+    def setEventSourceRef(self, value):
+        if value is not None:
+            self.eventSourceRef = value
+        return self
+
+
+class BackgroundEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+
+class ModeSwitchedAckEvent(RTEEvent):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.eventSourceRef: RefType = None
+
+    def getEventSourceRef(self):
+        return self.eventSourceRef
+
+    def setEventSourceRef(self, value):
+        if value is not None:
+            self.eventSourceRef = value
+        return self