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

armodel/models/M2/AUTOSARTemplates/SystemTemplate/Fibex/Fibex4Lin/LinCommunication.py

@@ -1,149 +1,193 @@
-
-from abc import ABCMeta
-from typing import List
-
-from ......M2.MSR.Documentation.TextModel.BlockElements import DocumentationBlock
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import AREnum, ARNumerical, Integer, RefType, TimeValue
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral
-from ......M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreCommunication import Frame, FrameTriggering
-
-class LinFrame(Frame, metaclass = ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == LinFrame:
-            raise NotImplementedError("LinFrame is an abstract class.")
-        
-        super().__init__(parent, short_name)
-
-class LinUnconditionalFrame(LinFrame):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-class LinFrameTriggering(FrameTriggering):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.identifier = None                          # type: ARNumerical
-        self.linChecksum = None                         # type: ARLiteral
-
-    def getIdentifier(self):
-        return self.identifier
-
-    def setIdentifier(self, value):
-        if value is not None:
-            self.identifier = value
-        return self
-
-    def getLinChecksum(self):
-        return self.linChecksum
-
-    def setLinChecksum(self, value):
-        if value is not None:
-            self.linChecksum = value
-        return self
-
-class ResumePosition(AREnum):
-    CONTINUE_AT_IT_POSITION = "continueAtItPosition"
-    START_FROM_BEGINNING = "startFromBeginning"
-
-    def __init__(self):
-        super().__init__((
-            ResumePosition.CONTINUE_AT_IT_POSITION,
-            ResumePosition.START_FROM_BEGINNING
-        ))
-
-class ScheduleTableEntry(ARObject, metaclass = ABCMeta):
-    def __init__(self):
-        
-        if type(self) == ScheduleTableEntry:
-            raise NotImplementedError("ScheduleTableEntry is an abstract class.")
-        
-        super().__init__()
-
-        self.delay = None                                       # type: TimeValue
-        self.introduction = None                                # type: DocumentationBlock
-        self.positionInTable = None                             # type: Integer
-
-    def getDelay(self):
-        return self.delay
-
-    def setDelay(self, value):
-        if value is not None:
-            self.delay = value
-        return self
-
-    def getIntroduction(self):
-        return self.introduction
-
-    def setIntroduction(self, value):
-        if value is not None:
-            self.introduction = value
-        return self
-
-    def getPositionInTable(self):
-        return self.positionInTable
-
-    def setPositionInTable(self, value):
-        if value is not None:
-            self.positionInTable = value
-        return self
-
-class ApplicationEntry(ScheduleTableEntry):
-    def __init__(self):
-        super().__init__()
-
-        self.frameTriggeringRef = None                              # type: RefType
-
-    def getFrameTriggeringRef(self):
-        return self.frameTriggeringRef
-
-    def setFrameTriggeringRef(self, value):
-        if value is not None:
-            self.frameTriggeringRef = value
-        return self
-
-class FreeFormatEntry(ScheduleTableEntry):
-    def __init__(self):
-        super().__init__()
-
-class LinConfigurationEntry(ScheduleTableEntry, metaclass = ABCMeta):
-    def __init__(self):
-
-        if type(self) == LinConfigurationEntry:
-            raise NotImplementedError("LinConfigurationEntry is an abstract class.")
-        
-        super().__init__()
-
-
-class LinScheduleTable(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.resumePosition = None                              # type: ResumePosition
-        self.runMode = None                                     # type: RunMode
-        self.tableEntries = []                                  # type: List[ScheduleTableEntry]
-
-    def getResumePosition(self):
-        return self.resumePosition
-
-    def setResumePosition(self, value):
-        if value is not None:
-            self.resumePosition = value
-        return self
-
-    def getRunMode(self):
-        return self.runMode
-
-    def setRunMode(self, value):
-        if value is not None:
-            self.runMode = value
-        return self
-    
-    def getTableEntries(self):
-        return self.tableEntries
-
-    def addTableEntry(self, value):
-        if value is not None:
-            self.tableEntries.append(value)
-        return self
+from abc import ABC
+from typing import List
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import AREnum, ARNumerical, Integer, RefType, TimeValue
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral
+from armodel.models.M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreCommunication import Frame, FrameTriggering
+
+class LinFrame(Frame, ABC):
+    """
+    Abstract base class for LIN frames, extending the generic Frame class
+    with LIN-specific properties and behavior. This class serves as the
+    foundation for concrete LIN frame implementations.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) == LinFrame:
+            raise TypeError("LinFrame is an abstract class.")
+        
+        super().__init__(parent, short_name)
+
+class LinUnconditionalFrame(LinFrame):
+    """
+    Represents an unconditional LIN frame in the AUTOSAR system,
+    defining the structure and properties for LIN messages that
+    are transmitted without conditional logic.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+class LinFrameTriggering(FrameTriggering):
+    """
+    Defines the triggering mechanism for LIN frames, specifying how and when
+    LIN frames are transmitted or received on the network, including
+    identifier and checksum properties.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.identifier: ARNumerical = None
+        self.linChecksum: ARLiteral = None
+
+    def getIdentifier(self):
+        return self.identifier
+
+    def setIdentifier(self, value):
+        if value is not None:
+            self.identifier = value
+        return self
+
+    def getLinChecksum(self):
+        return self.linChecksum
+
+    def setLinChecksum(self, value):
+        if value is not None:
+            self.linChecksum = value
+        return self
+
+class ResumePosition(AREnum):
+    """
+    Enumeration defining possible resume positions for LIN schedule tables,
+    specifying where execution should continue after an interruption.
+    """
+    CONTINUE_AT_IT_POSITION = "continueAtItPosition"
+    START_FROM_BEGINNING = "startFromBeginning"
+
+    def __init__(self):
+        super().__init__((
+            ResumePosition.CONTINUE_AT_IT_POSITION,
+            ResumePosition.START_FROM_BEGINNING
+        ))
+
+class ScheduleTableEntry(ARObject, ABC):
+    """
+    Abstract base class for schedule table entries, defining common
+    properties for different types of entries in LIN schedule tables
+    including timing, position, and documentation properties.
+    """
+    def __init__(self):
+        
+        if type(self) == ScheduleTableEntry:
+            raise TypeError("ScheduleTableEntry is an abstract class.")
+        
+        super().__init__()
+
+        self.delay: TimeValue = None
+        self.introduction = None                                # type: DocumentationBlock
+        self.positionInTable: Integer = None
+
+    def getDelay(self):
+        return self.delay
+
+    def setDelay(self, value):
+        if value is not None:
+            self.delay = value
+        return self
+
+    def getIntroduction(self):
+        return self.introduction
+
+    def setIntroduction(self, value):
+        if value is not None:
+            self.introduction = value
+        return self
+
+    def getPositionInTable(self):
+        return self.positionInTable
+
+    def setPositionInTable(self, value):
+        if value is not None:
+            self.positionInTable = value
+        return self
+
+class ApplicationEntry(ScheduleTableEntry):
+    """
+    Defines an application entry in a LIN schedule table,
+    specifying frame triggering references for application-level
+    communication entries in the schedule.
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.frameTriggeringRef: RefType = None
+
+    def getFrameTriggeringRef(self):
+        return self.frameTriggeringRef
+
+    def setFrameTriggeringRef(self, value):
+        if value is not None:
+            self.frameTriggeringRef = value
+        return self
+
+class FreeFormatEntry(ScheduleTableEntry, ABC):
+    """
+    Defines a free format entry in a LIN schedule table,
+    allowing for flexible schedule entries without specific
+    frame triggering references.
+    """
+
+    def __init__(self):
+        if type(self) is FreeFormatEntry:
+            raise TypeError("FreeFormatEntry is an abstract class.")
+        super().__init__()
+
+class LinConfigurationEntry(ScheduleTableEntry, ABC):
+    """
+    Abstract base class for LIN configuration entries in schedule tables,
+    defining common properties for configuration-related schedule entries.
+    """
+    def __init__(self):
+
+        if type(self) == LinConfigurationEntry:
+            raise TypeError("LinConfigurationEntry is an abstract class.")
+        
+        super().__init__()
+
+
+class LinScheduleTable(Identifiable):
+    """
+    Represents a LIN schedule table defining the timing and sequence
+    of LIN frame transmissions, including resume position, run mode,
+    and table entries for scheduled communication.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.resumePosition = None                              # type: ResumePosition
+        self.runMode = None                                     # type: RunMode
+        self.tableEntries: List[ScheduleTableEntry] = []
+
+    def getResumePosition(self):
+        return self.resumePosition
+
+    def setResumePosition(self, value):
+        if value is not None:
+            self.resumePosition = value
+        return self
+
+    def getRunMode(self):
+        return self.runMode
+
+    def setRunMode(self, value):
+        if value is not None:
+            self.runMode = value
+        return self
+    
+    def getTableEntries(self):
+        return self.tableEntries
+
+    def addTableEntry(self, value):
+        if value is not None:
+            self.tableEntries.append(value)
+        return self

armodel/models/M2/AUTOSARTemplates/SystemTemplate/Fibex/Fibex4Lin/LinTopology.py

@@ -1,92 +1,110 @@
-from typing import List
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Integer, String, TimeValue
-from .......models.M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreTopology import CommunicationConnector, CommunicationController
-
-
-class LinCommunicationController(CommunicationController):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.protocolVersion = None                                     # type: String
-
-    def getProtocolVersion(self):
-        return self.protocolVersion
-
-    def setProtocolVersion(self, value):
-        if value is not None:
-            self.protocolVersion = value
-        return self
-
-class LinMaster(LinCommunicationController):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.linSlaves = []                                             # type: List[LinSlaveConfig]
-        self.timeBase = None                                            # type: TimeValue
-        self.timeBaseJitter = None                                      # type: TimeValue
-
-    def getLinSlaves(self):
-        return self.linSlaves
-
-    def addLinSlaves(self, value):
-        if value is not None:
-            self.linSlaves.append(value)
-        return self
-
-    def getTimeBase(self):
-        return self.timeBase
-
-    def setTimeBase(self, value):
-        if value is not None:
-            self.timeBase = value
-        return self
-
-    def getTimeBaseJitter(self):
-        return self.timeBaseJitter
-
-    def setTimeBaseJitter(self, value):
-        if value is not None:
-            self.timeBaseJitter = value
-        return self
-
-class LinCommunicationConnector(CommunicationConnector):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.initialNad = None                                      # type: Integer
-        self.linConfigurableFrames = []                             # type: List[LinConfigurableFrame]
-        self.linOrderedConfigurableFrames = []                      # type: List[LinOrderedConfigurableFrame]
-        self.scheduleChangeNextTimeBase = None                      # type: Boolean
-
-    def getInitialNad(self):
-        return self.initialNad
-
-    def setInitialNad(self, value):
-        if value is not None:
-            self.initialNad = value
-        return self
-
-    def getLinConfigurableFrames(self):
-        return self.linConfigurableFrames
-
-    def addLinConfigurableFrame(self, value):
-        if value is not None:
-            self.linConfigurableFrames.append(value)
-        return self
-
-    def getLinOrderedConfigurableFrames(self):
-        return self.linOrderedConfigurableFrames
-
-    def addLinOrderedConfigurableFrame(self, value):
-        if value is not None:
-            self.linOrderedConfigurableFrames.append(value)
-        return self
-
-    def getScheduleChangeNextTimeBase(self):
-        return self.scheduleChangeNextTimeBase
-
-    def setScheduleChangeNextTimeBase(self, value):
-        if value is not None:
-            self.scheduleChangeNextTimeBase = value
-        return self
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Boolean, Integer, String, TimeValue
+from armodel.models.M2.AUTOSARTemplates.SystemTemplate.Fibex.FibexCore.CoreTopology import CommunicationConnector, CommunicationController
+
+
+class LinCommunicationController(CommunicationController, ABC):
+    """
+    Represents a LIN communication controller in the system,
+    defining properties for LIN network communication including
+    protocol version specifications.
+    """
+
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is LinCommunicationController:
+            raise TypeError("LinCommunicationController is an abstract class.")
+        super().__init__(parent, short_name)
+
+        self.protocolVersion: String = None
+
+    def getProtocolVersion(self):
+        return self.protocolVersion
+
+    def setProtocolVersion(self, value):
+        if value is not None:
+            self.protocolVersion = value
+        return self
+
+class LinMaster(LinCommunicationController):
+    """
+    Defines a LIN master node in the network topology, specifying
+    slave configurations, time base settings, and timing jitter
+    properties for LIN master communication management.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.linSlaves = []
+        self.timeBase: TimeValue = None
+        self.timeBaseJitter: TimeValue = None
+
+    def getLinSlaves(self):
+        return self.linSlaves
+
+    def addLinSlaves(self, value):
+        if value is not None:
+            self.linSlaves.append(value)
+        return self
+
+    def getTimeBase(self):
+        return self.timeBase
+
+    def setTimeBase(self, value):
+        if value is not None:
+            self.timeBase = value
+        return self
+
+    def getTimeBaseJitter(self):
+        return self.timeBaseJitter
+
+    def setTimeBaseJitter(self, value):
+        if value is not None:
+            self.timeBaseJitter = value
+        return self
+
+class LinCommunicationConnector(CommunicationConnector):
+    """
+    Defines a LIN communication connector that links LIN controllers
+    to communication channels, specifying initial NAD (Node Address),
+    configurable frames, and schedule change properties for LIN communication.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.initialNad: Integer = None
+        self.linConfigurableFrames = []
+        self.linOrderedConfigurableFrames = []
+        self.scheduleChangeNextTimeBase: Boolean = None
+
+    def getInitialNad(self):
+        return self.initialNad
+
+    def setInitialNad(self, value):
+        if value is not None:
+            self.initialNad = value
+        return self
+
+    def getLinConfigurableFrames(self):
+        return self.linConfigurableFrames
+
+    def addLinConfigurableFrame(self, value):
+        if value is not None:
+            self.linConfigurableFrames.append(value)
+        return self
+
+    def getLinOrderedConfigurableFrames(self):
+        return self.linOrderedConfigurableFrames
+
+    def addLinOrderedConfigurableFrame(self, value):
+        if value is not None:
+            self.linOrderedConfigurableFrames.append(value)
+        return self
+
+    def getScheduleChangeNextTimeBase(self):
+        return self.scheduleChangeNextTimeBase
+
+    def setScheduleChangeNextTimeBase(self, value):
+        if value is not None:
+            self.scheduleChangeNextTimeBase = value
+        return self