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

armodel/models/M2/AUTOSARTemplates/CommonStructure/StandardizationTemplate/Keyword.py

@@ -1,45 +1,126 @@
-from typing import List
-
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import NameToken
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement, Identifiable
-
-
-class Keyword(Identifiable):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.abbrName = None                                # type: NameToken
-        self.classifications = []                           # type: List[NameToken]
-
-    def getAbbrName(self):
-        return self.abbrName
-
-    def setAbbrName(self, value):
-        if value is not None:
-            self.abbrName = value
-        return self
-
-    def getClassifications(self):
-        return self.classifications
-
-    def addClassification(self, value):
-        if value is not None:
-            self.classifications.append(value)
-        return self
-
-
-class KeywordSet(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.keywords = []                                  # type: List[Keyword]
-
-    def getKeywords(self):
-        return self.keywords
-
-    def createKeyword(self, short_name: str) -> Keyword:
-        if (not self.IsElementExists(short_name)):
-            keyword = Keyword(self, short_name)
-            self.addElement(keyword)
-            self.keywords.append(keyword)
-        return self.getElement(short_name)
+"""
+This module contains classes for representing AUTOSAR keyword structures
+in the StandardizationTemplate module. Keywords are used for standardization
+and classification purposes in AUTOSAR models.
+"""
+
+from typing import List
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import NameToken
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement, Identifiable
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpBlueprintable
+
+
+class Keyword(Identifiable):
+    """
+    Represents a keyword in AUTOSAR models for standardization and classification purposes.
+    Keywords can have abbreviated names and classifications for organizing and categorizing elements.
+    """
+    
+    def __init__(self, parent, short_name):
+        """
+        Initializes the Keyword with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this keyword
+            short_name: The unique short name of this keyword
+        """
+        super().__init__(parent, short_name)
+
+        # Abbreviated name for this keyword
+        self.abbrName: NameToken = None                                
+        # List of classifications for this keyword
+        self.classifications: List[NameToken] = []                           
+
+    def getAbbrName(self):
+        """
+        Gets the abbreviated name for this keyword.
+        
+        Returns:
+            NameToken: The abbreviated name
+        """
+        return self.abbrName
+
+    def setAbbrName(self, value):
+        """
+        Sets the abbreviated name for this keyword.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The abbreviated name to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.abbrName = value
+        return self
+
+    def getClassifications(self):
+        """
+        Gets the list of classifications for this keyword.
+        
+        Returns:
+            List of NameToken instances
+        """
+        return self.classifications
+
+    def addClassification(self, value):
+        """
+        Adds a classification to this keyword.
+        Only adds the value if it is not None.
+        
+        Args:
+            value: The classification to add
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.classifications.append(value)
+        return self
+
+
+class KeywordSet(AtpBlueprintable):
+    """
+    Represents a set of keywords in AUTOSAR models for standardization and classification purposes.
+    This class contains multiple keywords that are grouped together for organizational purposes.
+    """
+
+    def __init__(self, parent, short_name):
+        """
+        Initializes the KeywordSet with a parent and short name.
+
+        Args:
+            parent: The parent ARObject that contains this keyword set
+            short_name: The unique short name of this keyword set
+        """
+        super().__init__(parent, short_name)
+
+        # List of keywords in this keyword set
+        self.keywords: List[Keyword] = []                                 
+
+    def getKeywords(self):
+        """
+        Gets the list of keywords in this keyword set.
+        
+        Returns:
+            List of Keyword instances
+        """
+        return self.keywords
+
+    def createKeyword(self, short_name: str) -> Keyword:
+        """
+        Creates and adds a Keyword to this keyword set.
+        
+        Args:
+            short_name: The short name for the new keyword
+            
+        Returns:
+            The created Keyword instance
+        """
+        if (not self.IsElementExists(short_name)):
+            keyword = Keyword(self, short_name)
+            self.addElement(keyword)
+            self.keywords.append(keyword)
+        return self.getElement(short_name)

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

@@ -0,0 +1,5 @@
+"""
+StandardizationTemplate module for AUTOSAR M2 models.
+"""
+
+from . import *

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

@@ -1,77 +1,290 @@
-from typing import List
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-
-class SwcBswRunnableMapping(ARObject):
-    def __init__(self):
-        '''
-            Maps a BswModuleEntity to a RunnableEntity if it is implemented as part of a BSW
-            module (in the case of an AUTOSAR Service, a Complex Driver or an ECU
-            Abstraction). The mapping can be used by a tool to find relevant information on the
-            behavior, e.g. whether the bswEntity shall be running in interrupt context.
-
-        '''
-        super().__init__()
-
-        self.bswEntityRef = None        # type: RefType
-        self.swcRunnableRef = None        # type: RefType
-
-    def getBswEntityRef(self):
-        return self.bswEntityRef
-
-    def setBswEntityRef(self, value):
-        self.bswEntityRef = value
-        return self
-
-    def getSwcRunnableRef(self):
-        return self.swcRunnableRef
-
-    def setSwcRunnableRef(self, value):
-        self.swcRunnableRef = value
-        return self
-
-class SwcBswMapping(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.bswBehaviorRef = None              # type: RefType
-        self.runnableMappings = []              # type: List[SwcBswRunnableMapping]
-        self.swcBehaviorRef = None              # type: RefType
-        self.synchronizedModeGroups = []
-        self.synchronizedTriggers = []
-
-    def getBswBehaviorRef(self):
-        return self.bswBehaviorRef
-
-    def setBswBehaviorRef(self, value):
-        self.bswBehaviorRef = value
-        return self
-
-    def getRunnableMappings(self):
-        return self.runnableMappings
-
-    def addRunnableMapping(self, value):
-        self.runnableMappings.append(value)
-        return self
-
-    def getSwcBehaviorRef(self):
-        return self.swcBehaviorRef
-
-    def setSwcBehaviorRef(self, value):
-        self.swcBehaviorRef = value
-        return self
-
-    def getSynchronizedModeGroups(self):
-        return self.synchronizedModeGroups
-
-    def setSynchronizedModeGroups(self, value):
-        self.synchronizedModeGroups = value
-        return self
-
-    def getSynchronizedTriggers(self):
-        return self.synchronizedTriggers
-
-    def setSynchronizedTriggers(self, value):
-        self.synchronizedTriggers = value
-        return self
+"""
+This module contains classes for representing AUTOSAR SWC-BSW mapping structures
+in the CommonStructure module. SWC-BSW mapping defines relationships between
+software component entities and basic software module entities for integration purposes.
+"""
+
+from typing import List
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpStructureElement
+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 SwcBswRunnableMapping(ARObject):
+    """
+    Represents a mapping between BSW module entities and SWC runnable entities in AUTOSAR models.
+    Maps a BswModuleEntity to a RunnableEntity if it is implemented as part of a BSW
+    module (in the case of an AUTOSAR Service, a Complex Driver or an ECU
+    Abstraction). The mapping can be used by a tool to find relevant information on the
+    behavior, e.g. whether the bswEntity shall be running in interrupt context.
+    """
+    
+    def __init__(self):
+        """
+        Initializes the SwcBswRunnableMapping with default values.
+        """
+        super().__init__()
+
+        # Reference to the BSW module entity in this mapping
+        self.bswEntityRef: RefType = None        
+        # Reference to the SWC runnable entity in this mapping
+        self.swcRunnableRef: RefType = None        
+
+    def getBswEntityRef(self):
+        """
+        Gets the reference to the BSW module entity in this mapping.
+        
+        Returns:
+            RefType: The BSW entity reference
+        """
+        return self.bswEntityRef
+
+    def setBswEntityRef(self, value):
+        """
+        Sets the reference to the BSW module entity in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The BSW entity reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.bswEntityRef = value
+        return self
+
+    def getSwcRunnableRef(self):
+        """
+        Gets the reference to the SWC runnable entity in this mapping.
+        
+        Returns:
+            RefType: The SWC runnable reference
+        """
+        return self.swcRunnableRef
+
+    def setSwcRunnableRef(self, value):
+        """
+        Sets the reference to the SWC runnable entity in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The SWC runnable reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.swcRunnableRef = value
+        return self
+
+class SwcBswMapping(AtpStructureElement):
+    """
+    Represents SWC-BSW mapping in AUTOSAR models.
+    This class defines mappings between software component (SWC) behavior and basic software (BSW) behavior.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the SwcBswMapping with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this SWC-BSW mapping
+            short_name: The unique short name of this SWC-BSW mapping
+        """
+        super().__init__(parent, short_name)
+
+        # Reference to the BSW behavior in this mapping
+        self.bswBehaviorRef: RefType = None              
+        # List of runnable mappings in this SWC-BSW mapping
+        self.runnableMappings: List[SwcBswRunnableMapping] = []              
+        # Reference to the SWC behavior in this mapping
+        self.swcBehaviorRef: RefType = None              
+        # List of synchronized mode groups in this mapping
+        self.synchronizedModeGroups = []
+        # List of synchronized triggers in this mapping
+        self.synchronizedTriggers = []
+
+    def getBswBehaviorRef(self):
+        """
+        Gets the reference to the BSW behavior in this mapping.
+        
+        Returns:
+            RefType: The BSW behavior reference
+        """
+        return self.bswBehaviorRef
+
+    def setBswBehaviorRef(self, value):
+        """
+        Sets the reference to the BSW behavior in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The BSW behavior reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.bswBehaviorRef = value
+        return self
+
+    def getRunnableMappings(self):
+        """
+        Gets the list of runnable mappings in this SWC-BSW mapping.
+        
+        Returns:
+            List of SwcBswRunnableMapping instances
+        """
+        return self.runnableMappings
+
+    def addRunnableMapping(self, value):
+        """
+        Adds a runnable mapping to this SWC-BSW mapping.
+        
+        Args:
+            value: The runnable mapping to add
+            
+        Returns:
+            self for method chaining
+        """
+        self.runnableMappings.append(value)
+        return self
+
+    def getSwcBehaviorRef(self):
+        """
+        Gets the reference to the SWC behavior in this mapping.
+        
+        Returns:
+            RefType: The SWC behavior reference
+        """
+        return self.swcBehaviorRef
+
+    def setSwcBehaviorRef(self, value):
+        """
+        Sets the reference to the SWC behavior in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The SWC behavior reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.swcBehaviorRef = value
+        return self
+
+    def getSynchronizedModeGroups(self):
+        """
+        Gets the list of synchronized mode groups in this mapping.
+        
+        Returns:
+            List of synchronized mode group objects
+        """
+        return self.synchronizedModeGroups
+
+    def setSynchronizedModeGroups(self, value):
+        """
+        Sets the list of synchronized mode groups in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The synchronized mode groups list to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.synchronizedModeGroups = value
+        return self
+
+    def getSynchronizedTriggers(self):
+        """
+        Gets the list of synchronized triggers in this mapping.
+        
+        Returns:
+            List of synchronized trigger objects
+        """
+        return self.synchronizedTriggers
+
+    def setSynchronizedTriggers(self, value):
+        """
+        Sets the list of synchronized triggers in this mapping.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The synchronized triggers list to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.synchronizedTriggers = value
+        return self
+
+
+class SwcBswSynchronizedModeGroupPrototype(ARObject):
+    """
+    Represents a SWC-BSW synchronized mode group prototype in AUTOSAR.
+    Defines a synchronized mode group prototype for SWC-BSW mapping.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SwcBswSynchronizedModeGroupPrototype with default values.
+        """
+        super().__init__()
+        self.modeGroupRef: RefType = None
+
+    def getModeGroupRef(self) -> RefType:
+        """
+        Gets the mode group reference.
+
+        Returns:
+            Reference to the mode group
+        """
+        return self.modeGroupRef
+
+    def setModeGroupRef(self, value: RefType):
+        """
+        Sets the mode group reference.
+
+        Args:
+            value: The mode group reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.modeGroupRef = value
+        return self
+
+
+class SwcBswSynchronizedTrigger(ARObject):
+    """
+    Represents a SWC-BSW synchronized trigger in AUTOSAR.
+    Defines a synchronized trigger for SWC-BSW mapping.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SwcBswSynchronizedTrigger with default values.
+        """
+        super().__init__()
+        self.triggerRef: RefType = None
+
+    def getTriggerRef(self) -> RefType:
+        """
+        Gets the trigger reference.
+
+        Returns:
+            Reference to the trigger
+        """
+        return self.triggerRef
+
+    def setTriggerRef(self, value: RefType):
+        """
+        Sets the trigger reference.
+
+        Args:
+            value: The trigger reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.triggerRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/Timing/TimingClock/TDLETZoneClock.py

@@ -0,0 +1,61 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+
+
+class TDLETZoneClock(ARObject):
+    """
+    Represents a TDLET zone clock in AUTOSAR timing specifications.
+    Defines a clock for TDLET (Time Domain LET) zones.
+    """
+
+    def __init__(self):
+        """
+        Initializes the TDLETZoneClock with default values.
+        """
+        super().__init__()
+        self.clockRef: RefType = None
+        self.zoneRef: RefType = None
+
+    def getClockRef(self) -> RefType:
+        """
+        Gets the clock reference.
+
+        Returns:
+            Reference to the clock
+        """
+        return self.clockRef
+
+    def setClockRef(self, value: RefType):
+        """
+        Sets the clock reference.
+
+        Args:
+            value: The clock reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.clockRef = value
+        return self
+
+    def getZoneRef(self) -> RefType:
+        """
+        Gets the zone reference.
+
+        Returns:
+            Reference to the zone
+        """
+        return self.zoneRef
+
+    def setZoneRef(self, value: RefType):
+        """
+        Sets the zone reference.
+
+        Args:
+            value: The zone reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.zoneRef = value
+        return self

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

@@ -0,0 +1,60 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+
+class TimingClock(ARObject):
+    """
+    Represents a timing clock in AUTOSAR timing specifications.
+    Defines a clock used for timing analysis and synchronization.
+    """
+
+    def __init__(self):
+        """
+        Initializes the TimingClock with default values.
+        """
+        super().__init__()
+        self.clockName: str = None
+        self.clockType: str = None
+
+    def getClockName(self) -> str:
+        """
+        Gets the clock name.
+
+        Returns:
+            String representing the clock name
+        """
+        return self.clockName
+
+    def setClockName(self, value: str):
+        """
+        Sets the clock name.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.clockName = value
+        return self
+
+    def getClockType(self) -> str:
+        """
+        Gets the clock type.
+
+        Returns:
+            String representing the clock type
+        """
+        return self.clockType
+
+    def setClockType(self, value: str):
+        """
+        Sets the clock type.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.clockType = value
+        return self