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

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

@@ -1,58 +1,62 @@
-from typing import List
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-
-class DiagnosticConnection(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.functionalRequestRefs = []                         # type: List[RefType]
-        self.periodicResponseUudtRefs = []                      # type: List[RefType]
-        self.physicalRequestRef = None                          # type: RefType
-        self.responseRef = None                                 # type: RefType
-        self.responseOnEventRef = None                          # type: RefType
-
-    def getFunctionalRequestRefs(self):
-        return self.functionalRequestRefs
-
-    def addFunctionalRequestRef(self, value):
-        if value is not None:
-            self.functionalRequestRefs.append(value)
-        return self
-
-    def getPeriodicResponseUudtRefs(self):
-        return self.periodicResponseUudtRefs
-
-    def addPeriodicResponseUudtRef(self, value):
-        if value is not None:
-            self.periodicResponseUudtRefs.append(value)
-        return self
-
-    def getPhysicalRequestRef(self):
-        return self.physicalRequestRef
-
-    def setPhysicalRequestRef(self, value):
-        if value is not None:
-            self.physicalRequestRef = value
-        return self
-
-    def getResponseRef(self):
-        return self.responseRef
-
-    def setResponseRef(self, value):
-        if value is not None:
-            self.responseRef = value
-        return self
-
-    def getResponseOnEventRef(self):
-        return self.responseOnEventRef
-
-    def setResponseOnEventRef(self, value):
-        if value is not None:
-            self.responseOnEventRef = value
-        return self
-
-
-    
-
-
+# This module contains AUTOSAR System Template classes for diagnostic connections
+# It defines connections for diagnostic services and communication between diagnostic entities
+
+from typing import List
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
+
+class DiagnosticConnection(ARElement):
+    """
+    Represents a diagnostic connection in the AUTOSAR system, defining the relationship
+    between diagnostic services and their communication endpoints. This class connects
+    functional requests, physical requests, and responses within the diagnostic communication
+    infrastructure of the system.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.functionalRequestRefs: List[RefType] = []
+        self.periodicResponseUudtRefs: List[RefType] = []
+        self.physicalRequestRef: RefType = None
+        self.responseRef: RefType = None
+        self.responseOnEventRef: RefType = None
+
+    def getFunctionalRequestRefs(self):
+        return self.functionalRequestRefs
+
+    def addFunctionalRequestRef(self, value):
+        if value is not None:
+            self.functionalRequestRefs.append(value)
+        return self
+
+    def getPeriodicResponseUudtRefs(self):
+        return self.periodicResponseUudtRefs
+
+    def addPeriodicResponseUudtRef(self, value):
+        if value is not None:
+            self.periodicResponseUudtRefs.append(value)
+        return self
+
+    def getPhysicalRequestRef(self):
+        return self.physicalRequestRef
+
+    def setPhysicalRequestRef(self, value):
+        if value is not None:
+            self.physicalRequestRef = value
+        return self
+
+    def getResponseRef(self):
+        return self.responseRef
+
+    def setResponseRef(self, value):
+        if value is not None:
+            self.responseRef = value
+        return self
+
+    def getResponseOnEventRef(self):
+        return self.responseOnEventRef
+
+    def setResponseOnEventRef(self, value):
+        if value is not None:
+            self.responseOnEventRef = value
+        return self

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

@@ -1,29 +1,48 @@
-from abc import ABCMeta
-
-from .....models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-
-class AbstractDoIpLogicAddressProps(Identifiable, metaclass = ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == AbstractDoIpLogicAddressProps:
-            raise NotImplementedError("AbstractDoIpLogicAddressProps is an abstract class.")
-        
-        super().__init__(parent, short_name)
-
-class DoIpLogicTargetAddressProps(AbstractDoIpLogicAddressProps):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-class DoIpLogicTesterAddressProps(AbstractDoIpLogicAddressProps):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.doIpTesterRoutingActivationRef = None                              # type: RefType
-
-    def getDoIpTesterRoutingActivationRef(self):
-        return self.doIpTesterRoutingActivationRef
-
-    def setDoIpTesterRoutingActivationRef(self, value):
-        if value is not None:
-            self.doIpTesterRoutingActivationRef = value
-        return self
+# This module contains AUTOSAR System Template classes for DoIP (Diagnostics over IP)
+# It defines logic address properties and configurations for DoIP communication
+
+from abc import ABC
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+
+class AbstractDoIpLogicAddressProps(Identifiable, ABC):
+    """
+    Abstract base class for DoIP (Diagnostics over IP) logic address properties.
+    This class defines the common properties for DoIP address configurations,
+    serving as the foundation for specific DoIP address types in the system.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) == AbstractDoIpLogicAddressProps:
+            raise TypeError("AbstractDoIpLogicAddressProps is an abstract class.")
+        
+        super().__init__(parent, short_name)
+
+class DoIpLogicTargetAddressProps(AbstractDoIpLogicAddressProps):
+    """
+    Defines properties for DoIP (Diagnostics over IP) logic target addresses,
+    specifying how diagnostic messages should be addressed to target ECUs
+    in the IP-based diagnostic communication system.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+class DoIpLogicTesterAddressProps(AbstractDoIpLogicAddressProps):
+    """
+    Defines properties for DoIP (Diagnostics over IP) logic tester addresses,
+    specifying how diagnostic tools and testers are addressed in the IP-based
+    diagnostic communication system, including routing activation references.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.doIpTesterRoutingActivationRef: RefType = None
+
+    def getDoIpTesterRoutingActivationRef(self):
+        return self.doIpTesterRoutingActivationRef
+
+    def setDoIpTesterRoutingActivationRef(self, value):
+        if value is not None:
+            self.doIpTesterRoutingActivationRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/SystemTemplate/{EcuResourceMapping.py → ECUResourceMapping.py}

@@ -1,45 +1,48 @@
-from typing import List
-from ..GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ..GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-
-
-class ECUMapping(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.commControllerMappings = []                                # type: List[CommunicationControllerMapping]
-        self.ecuRef = None                                              # type: RefType
-        self.ecuInstanceRef = None                                      # type: RefType
-        self.hwPortMappings = []                                        # type: List[HwPortMapping]
-
-    def getCommControllerMappings(self):
-        return self.commControllerMappings
-
-    def setCommControllerMappings(self, value):
-        if value is not None:
-            self.commControllerMappings = value
-        return self
-
-    def getEcuRef(self):
-        return self.ecuRef
-
-    def setEcuRef(self, value):
-        if value is not None:
-            self.ecuRef = value
-        return self
-
-    def getEcuInstanceRef(self):
-        return self.ecuInstanceRef
-
-    def setEcuInstanceRef(self, value):
-        if value is not None:
-            self.ecuInstanceRef = value
-        return self
-
-    def getHwPortMappings(self):
-        return self.hwPortMappings
-
-    def setHwPortMappings(self, value):
-        if value is not None:
-            self.hwPortMappings = value
-        return self
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class ECUMapping(Identifiable):
+    """
+    Represents an ECU mapping that defines the relationship between AUTOSAR software components
+    and their physical ECU instances. This class maps communication controllers, hardware ports,
+    and other ECU resources to specific ECU instances within the system configuration.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.commControllerMappings = []                                # type: List[CommunicationControllerMapping]
+        self.ecuRef = None                                              # type: RefType
+        self.ecuInstanceRef = None                                      # type: RefType
+        self.hwPortMappings = []                                        # type: List[HwPortMapping]
+
+    def getCommControllerMappings(self):
+        return self.commControllerMappings
+
+    def setCommControllerMappings(self, value):
+        if value is not None:
+            self.commControllerMappings = value
+        return self
+
+    def getEcuRef(self):
+        return self.ecuRef
+
+    def setEcuRef(self, value):
+        if value is not None:
+            self.ecuRef = value
+        return self
+
+    def getEcuInstanceRef(self):
+        return self.ecuInstanceRef
+
+    def setEcuInstanceRef(self, value):
+        if value is not None:
+            self.ecuInstanceRef = value
+        return self
+
+    def getHwPortMappings(self):
+        return self.hwPortMappings
+
+    def setHwPortMappings(self, value):
+        if value is not None:
+            self.hwPortMappings = value
+        return self

armodel/models/M2/AUTOSARTemplates/SystemTemplate/Fibex/Fibex4Can/CanCommunication.py

@@ -1,122 +1,139 @@
-from ......M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreCommunication import Frame, FrameTriggering
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARPositiveInteger
-
-class RxIdentifierRange(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.lowerCanId = None      # type: ARPositiveInteger
-        self.upperCanId = None      # type: ARPositiveInteger
-
-    def getLowerCanId(self) -> ARPositiveInteger:
-        return self.lowerCanId
-
-    def setLowerCanId(self, value: ARPositiveInteger):
-        self.lowerCanId = value
-        return self
-
-    def getUpperCanId(self) -> ARPositiveInteger:
-        return self.upperCanId
-
-    def setUpperCanId(self, value: ARPositiveInteger):
-        self.upperCanId = value
-        return self
-
-class CanFrame(Frame):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-class CanFrameTriggering(FrameTriggering):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.absolutelyScheduledTimings = []                    
-        self.canAddressingMode = None
-        self.canFdFrameSupport = None
-        self.canFrameRxBehavior = None
-        self.canFrameTxBehavior = None
-        self.canXlFrameTriggeringProps = None
-        self.identifier = None
-        self.j1939requestable = None
-        self.rxIdentifierRange = None                           # type: RxIdentifierRange
-        self.rxMask = None
-        self.txMask = None
-
-    def getAbsolutelyScheduledTimings(self):
-        return self.absolutelyScheduledTimings
-
-    def setAbsolutelyScheduledTimings(self, value):
-        self.absolutelyScheduledTimings = value
-        return self
-
-    def getCanAddressingMode(self):
-        return self.canAddressingMode
-
-    def setCanAddressingMode(self, value):
-        self.canAddressingMode = value
-        return self
-    
-    def getCanFdFrameSupport(self):
-        return self.canFdFrameSupport
-
-    def setCanFdFrameSupport(self, value):
-        self.canFdFrameSupport = value
-        return self
-
-    def getCanFrameRxBehavior(self):
-        return self.canFrameRxBehavior
-
-    def setCanFrameRxBehavior(self, value):
-        self.canFrameRxBehavior = value
-        return self
-
-    def getCanFrameTxBehavior(self):
-        return self.canFrameTxBehavior
-
-    def setCanFrameTxBehavior(self, value):
-        self.canFrameTxBehavior = value
-        return self
-
-    def getCanXlFrameTriggeringProps(self):
-        return self.canXlFrameTriggeringProps
-
-    def setCanXlFrameTriggeringProps(self, value):
-        self.canXlFrameTriggeringProps = value
-        return self
-
-    def getIdentifier(self):
-        return self.identifier
-
-    def setIdentifier(self, value):
-        self.identifier = value
-        return self
-
-    def getJ1939requestable(self):
-        return self.j1939requestable
-
-    def setJ1939requestable(self, value):
-        self.j1939requestable = value
-        return self
-
-    def getRxIdentifierRange(self) -> RxIdentifierRange:
-        return self.rxIdentifierRange
-
-    def setRxIdentifierRange(self, value: RxIdentifierRange):
-        self.rxIdentifierRange = value
-        return self
-
-    def getRxMask(self):
-        return self.rxMask
-
-    def setRxMask(self, value):
-        self.rxMask = value
-        return self
-
-    def getTxMask(self):
-        return self.txMask
-
-    def setTxMask(self, value):
-        self.txMask = value
-        return self
-
+# This module contains AUTOSAR System Template classes for CAN communication
+# It defines CAN frames, frame triggering, and related communication elements for CAN networks
+
+from armodel.models.M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreCommunication import Frame, FrameTriggering
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARPositiveInteger
+
+class RxIdentifierRange(ARObject):
+    """
+    Defines a range of CAN identifiers used for receive filtering in CAN communication.
+    This class specifies the lower and upper bounds of CAN message IDs that should
+    be accepted by a CAN controller or communication endpoint.
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.lowerCanId: ARPositiveInteger = None
+        self.upperCanId: ARPositiveInteger = None
+
+    def getLowerCanId(self) -> ARPositiveInteger:
+        return self.lowerCanId
+
+    def setLowerCanId(self, value: ARPositiveInteger):
+        self.lowerCanId = value
+        return self
+
+    def getUpperCanId(self) -> ARPositiveInteger:
+        return self.upperCanId
+
+    def setUpperCanId(self, value: ARPositiveInteger):
+        self.upperCanId = value
+        return self
+
+class CanFrame(Frame):
+    """
+    Represents a CAN frame in the AUTOSAR system, extending the generic Frame class
+    with CAN-specific properties and behavior. This class defines the structure
+    and characteristics of CAN messages in the communication system.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+class CanFrameTriggering(FrameTriggering):
+    """
+    Defines the triggering mechanism for CAN frames, specifying how and when
+    CAN frames are transmitted or received on the network, including timing,
+    addressing modes, and frame behavior properties.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.absolutelyScheduledTimings = []                    
+        self.canAddressingMode = None
+        self.canFdFrameSupport = None
+        self.canFrameRxBehavior = None
+        self.canFrameTxBehavior = None
+        self.canXlFrameTriggeringProps = None
+        self.identifier = None
+        self.j1939requestable = None
+        self.rxIdentifierRange: RxIdentifierRange = None
+        self.rxMask = None
+        self.txMask = None
+
+    def getAbsolutelyScheduledTimings(self):
+        return self.absolutelyScheduledTimings
+
+    def setAbsolutelyScheduledTimings(self, value):
+        self.absolutelyScheduledTimings = value
+        return self
+
+    def getCanAddressingMode(self):
+        return self.canAddressingMode
+
+    def setCanAddressingMode(self, value):
+        self.canAddressingMode = value
+        return self
+    
+    def getCanFdFrameSupport(self):
+        return self.canFdFrameSupport
+
+    def setCanFdFrameSupport(self, value):
+        self.canFdFrameSupport = value
+        return self
+
+    def getCanFrameRxBehavior(self):
+        return self.canFrameRxBehavior
+
+    def setCanFrameRxBehavior(self, value):
+        self.canFrameRxBehavior = value
+        return self
+
+    def getCanFrameTxBehavior(self):
+        return self.canFrameTxBehavior
+
+    def setCanFrameTxBehavior(self, value):
+        self.canFrameTxBehavior = value
+        return self
+
+    def getCanXlFrameTriggeringProps(self):
+        return self.canXlFrameTriggeringProps
+
+    def setCanXlFrameTriggeringProps(self, value):
+        self.canXlFrameTriggeringProps = value
+        return self
+
+    def getIdentifier(self):
+        return self.identifier
+
+    def setIdentifier(self, value):
+        self.identifier = value
+        return self
+
+    def getJ1939requestable(self):
+        return self.j1939requestable
+
+    def setJ1939requestable(self, value):
+        self.j1939requestable = value
+        return self
+
+    def getRxIdentifierRange(self) -> RxIdentifierRange:
+        return self.rxIdentifierRange
+
+    def setRxIdentifierRange(self, value: RxIdentifierRange):
+        self.rxIdentifierRange = value
+        return self
+
+    def getRxMask(self):
+        return self.rxMask
+
+    def setRxMask(self, value):
+        self.rxMask = value
+        return self
+
+    def getTxMask(self):
+        return self.txMask
+
+    def setTxMask(self, value):
+        self.txMask = value
+        return self