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

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/TimingConstraint/TimingConstraint.py

@@ -1,24 +1,59 @@
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from abc import ABCMeta
-
-
-class TimingConstraint(Identifiable):
-    __metaclass__ = ABCMeta
-
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == TimingConstraint:
-            raise NotImplementedError("TimingExtension is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.timing_condition_ref = None                # type: RefType
-
-    @property
-    def timingConditionRef(self) -> RefType:
-        return self.timing_condition_ref
-
-    @timingConditionRef.setter
-    def timingConditionRef(self, ref: RefType):
-        self.timing_condition_ref = ref
+"""
+This module defines the abstract base class for timing constraints in AUTOSAR.
+
+Timing constraints represent temporal relationships between AUTOSAR elements,
+such as execution order, timing requirements, and synchronization constraints.
+This module provides the base abstract class from which specific timing
+constraint types inherit their common functionality.
+
+Classes:
+    TimingConstraint: Abstract base class for all timing constraints
+"""
+
+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,
+)
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.Traceable import Traceable
+
+
+class TimingConstraint(Traceable, ABC):
+    """
+    Abstract base class for all timing constraints in AUTOSAR.
+    This class cannot be instantiated directly and serves as the base for concrete
+    timing constraint implementations such as execution order constraints.
+    """
+
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is TimingConstraint:
+            raise TypeError("TimingConstraint is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.timing_condition_ref: RefType = None
+
+    @property
+    def timingConditionRef(self) -> RefType:
+        """
+        Gets the timing condition reference for this constraint.
+
+        Returns:
+            Reference to the timing condition
+        """
+        return self.timing_condition_ref
+
+    @timingConditionRef.setter
+    def timingConditionRef(self, ref: RefType):
+        """
+        Sets the timing condition reference for this constraint.
+
+        Args:
+            ref: Reference to the timing condition
+        """
+        self.timing_condition_ref = ref

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/TimingConstraint/TimingExtensions.py

@@ -1,33 +1,70 @@
-from ......M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.ExecutionOrderConstraint import ExecutionOrderConstraint
-from ......M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingConstraint import TimingConstraint
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from abc import ABCMeta
-from typing import List
-
-
-class TimingExtension(Identifiable):
-    __metaclass__ = ABCMeta
-
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == TimingExtension:
-            raise NotImplementedError("TimingExtension is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.timing_requirements = []           # Type: List[TimingConstraint]
-
-    def createExecutionOrderConstraint(self, short_name: str)-> ExecutionOrderConstraint:
-        if not self.IsElementExists(short_name):
-            constraint = ExecutionOrderConstraint(self, short_name)
-            self.addElement(constraint)
-            self.timing_requirements.append(constraint)
-        return self.getElement(short_name, ExecutionOrderConstraint)
-
-    def getTimingRequirements(self) -> List[TimingConstraint]:
-        return self.timing_requirements
-
-
-class SwcTiming(TimingExtension):
-    def __init__(self, parent: ARObject, short_name: str):
+"""
+This module defines timing extension classes for AUTOSAR software component timing specifications.
+
+Timing extensions provide mechanisms to specify various timing constraints and requirements
+for AUTOSAR software components. This includes execution order constraints and other
+timing-related specifications that ensure proper temporal behavior of AUTOSAR components.
+
+Classes:
+    TimingExtension: Abstract base class for timing extensions
+    SwcTiming: Software component timing specification
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.ExecutionOrderConstraint import ExecutionOrderConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingConstraint import TimingConstraint
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable, ARElement
+from abc import ABC
+from typing import List
+
+
+class TimingExtension(ARElement):
+    """
+    Abstract base class for timing extensions in AUTOSAR.
+    This class cannot be instantiated directly and provides common functionality
+    for timing extension implementations such as software component timing specifications.
+    """
+    __metaclass__ = ABC
+
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) == TimingExtension:
+            raise TypeError("TimingExtension is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.timing_requirements: List[TimingConstraint] = []
+
+    def createExecutionOrderConstraint(self, short_name: str)-> ExecutionOrderConstraint:
+        """
+        Creates a new execution order constraint with the specified short name.
+        
+        Args:
+            short_name: Short name for the new execution order constraint
+            
+        Returns:
+            The created ExecutionOrderConstraint instance
+        """
+        if not self.IsElementExists(short_name):
+            constraint = ExecutionOrderConstraint(self, short_name)
+            self.addElement(constraint)
+            self.timing_requirements.append(constraint)
+        return self.getElement(short_name, ExecutionOrderConstraint)
+
+    def getTimingRequirements(self) -> List[TimingConstraint]:
+        """
+        Returns the list of timing requirements for this extension.
+        
+        Returns:
+            List of timing constraint requirements
+        """
+        return self.timing_requirements
+
+
+class SwcTiming(TimingExtension):
+    """
+    Software component timing specification that defines timing constraints
+    for AUTOSAR software components. This class extends TimingExtension to
+    provide component-specific timing functionality.
+    """
+    def __init__(self, parent: ARObject, short_name: str):
         super().__init__(parent, short_name)

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/TimingConstraint/__init__.py

@@ -0,0 +1,48 @@
+"""
+This module contains timing constraint-related classes for AUTOSAR models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingConstraint import TimingConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.ExecutionOrderConstraint import EOCExecutableEntityRefAbstract, EOCExecutableEntityRef, ExecutionOrderConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingExtensions import TimingExtension, SwcTiming
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.AgeConstraint import AgeConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.ExecutionTimeConstraint import ExecutionTimeConstraint, ExecutionTimeTypeEnum
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.LatencyTimingConstraint import LatencyTimingConstraint, LatencyConstraintTypeEnum
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.OffsetConstraint import OffsetTimingConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.SynchronizationPointConstraint import SynchronizationPointConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.SynchronizationTiming import SynchronizationTimingConstraint, SynchronizationTypeEnum, EventOccurrenceKindEnum
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.EventTriggeringConstraint import (
+    EventTriggeringConstraint,
+    PeriodicEventTriggering,
+    SporadicEventTriggering,
+    ArbitraryEventTriggering,
+    BurstPatternEventTriggering,
+    ConcretePatternEventTriggering,
+    ConfidenceInterval,
+)
+
+__all__ = [
+    'TimingConstraint',
+    'EOCExecutableEntityRefAbstract',
+    'EOCExecutableEntityRef',
+    'ExecutionOrderConstraint',
+    'TimingExtension',
+    'SwcTiming',
+    'AgeConstraint',
+    'ExecutionTimeConstraint',
+    'ExecutionTimeTypeEnum',
+    'LatencyTimingConstraint',
+    'LatencyConstraintTypeEnum',
+    'OffsetTimingConstraint',
+    'SynchronizationPointConstraint',
+    'SynchronizationTimingConstraint',
+    'SynchronizationTypeEnum',
+    'EventOccurrenceKindEnum',
+    'EventTriggeringConstraint',
+    'PeriodicEventTriggering',
+    'SporadicEventTriggering',
+    'ArbitraryEventTriggering',
+    'BurstPatternEventTriggering',
+    'ConcretePatternEventTriggering',
+    'ConfidenceInterval',
+]

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/Traceable.py

@@ -0,0 +1,11 @@
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import (
+    Identifiable,
+)
+
+
+class Traceable(Identifiable, ABC):
+    def __init__(self, parent, short_name: str):
+        if type(self) is Traceable:
+            raise TypeError("Traceable is an abstract class.")
+        super().__init__(parent, short_name)

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/__init__.py

@@ -0,0 +1,16 @@
+"""
+This module contains timing-related classes for AUTOSAR models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingConstraint import TimingConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.ExecutionOrderConstraint import EOCExecutableEntityRefAbstract, EOCExecutableEntityRef, ExecutionOrderConstraint
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.Timing.TimingConstraint.TimingExtensions import TimingExtension, SwcTiming
+
+__all__ = [
+    'TimingConstraint',
+    'EOCExecutableEntityRefAbstract', 
+    'EOCExecutableEntityRef', 
+    'ExecutionOrderConstraint',
+    'TimingExtension', 
+    'SwcTiming'
+]

armodel/models/M2/AUTOSARTemplates/CommonStructure/TriggerDeclaration.py

@@ -1,52 +1,147 @@
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from ....M2.MSR.DataDictionary.DataDefProperties import SwImplPolicyEnum
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-
-
-class Trigger(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.swImplPolicy: SwImplPolicyEnum = None
-        self.triggerPeriod = None                               # type: MultidimensionalTime
-
-    def getSwImplPolicy(self):
-        return self.swImplPolicy
-
-    def setSwImplPolicy(self, value):
-        if value is not None:
-            self.swImplPolicy = value
-        return self
-
-    def getTriggerPeriod(self):
-        return self.triggerPeriod
-
-    def setTriggerPeriod(self, value):
-        if value is not None:
-            self.triggerPeriod = value
-        return self
-
-
-class TriggerMapping(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.firstTriggerRef = None                             # type: RefType
-        self.secondTriggerRef = None                            # type: RefType
-
-    def getFirstTriggerRef(self):
-        return self.firstTriggerRef
-
-    def setFirstTriggerRef(self, value):
-        if value is not None:
-            self.firstTriggerRef = value
-        return self
-
-    def getSecondTriggerRef(self):
-        return self.secondTriggerRef
-
-    def setSecondTriggerRef(self, value):
-        if value is not None:
-            self.secondTriggerRef = value
-        return self
+"""
+This module contains classes for representing AUTOSAR trigger declaration structures
+in the CommonStructure module. Triggers define events that can initiate specific
+behaviors or actions in AUTOSAR components and systems.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpStructureElement
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.MSR.DataDictionary.DataDefProperties import SwImplPolicyEnum
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class Trigger(AtpStructureElement):
+    """
+    Represents a trigger in AUTOSAR models.
+    Triggers define events that can initiate specific behaviors or actions in AUTOSAR components and systems.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the Trigger with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this trigger
+            short_name: The unique short name of this trigger
+        """
+        super().__init__(parent, short_name)
+
+        # Software implementation policy for this trigger
+        self.swImplPolicy: SwImplPolicyEnum = None
+        # Period for this trigger (MultidimensionalTime type)
+        self.triggerPeriod = None                               
+
+    def getSwImplPolicy(self):
+        """
+        Gets the software implementation policy for this trigger.
+        
+        Returns:
+            SwImplPolicyEnum: The software implementation policy
+        """
+        return self.swImplPolicy
+
+    def setSwImplPolicy(self, value):
+        """
+        Sets the software implementation policy for this trigger.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The software implementation policy to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.swImplPolicy = value
+        return self
+
+    def getTriggerPeriod(self):
+        """
+        Gets the period for this trigger.
+        
+        Returns:
+            MultidimensionalTime: The trigger period
+        """
+        return self.triggerPeriod
+
+    def setTriggerPeriod(self, value):
+        """
+        Sets the period for this trigger.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The trigger period to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.triggerPeriod = value
+        return self
+
+
+class TriggerMapping(ARObject):
+    """
+    Represents a mapping between triggers in AUTOSAR models.
+    This class defines relationships between different triggers across system boundaries or components.
+    """
+    
+    def __init__(self):
+        """
+        Initializes the TriggerMapping with default values.
+        """
+        super().__init__()
+
+        # Reference to the first trigger in the mapping
+        self.firstTriggerRef: RefType = None                             
+        # Reference to the second trigger in the mapping
+        self.secondTriggerRef: RefType = None                            
+
+    def getFirstTriggerRef(self):
+        """
+        Gets the reference to the first trigger in the mapping.
+        
+        Returns:
+            RefType: The first trigger reference
+        """
+        return self.firstTriggerRef
+
+    def setFirstTriggerRef(self, value):
+        """
+        Sets the reference to the first trigger in the mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The first trigger reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.firstTriggerRef = value
+        return self
+
+    def getSecondTriggerRef(self):
+        """
+        Gets the reference to the second trigger in the mapping.
+        
+        Returns:
+            RefType: The second trigger reference
+        """
+        return self.secondTriggerRef
+
+    def setSecondTriggerRef(self, value):
+        """
+        Sets the reference to the second trigger in the mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The second trigger reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.secondTriggerRef = value
+        return self