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

armodel/models/M2/AUTOSARTemplates/CommonStructure/ResourceConsumption/ExecutionTime/__init__.py

@@ -0,0 +1,132 @@
+"""
+This module defines execution time resource consumption classes in AUTOSAR.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import TimeValue
+
+
+class AnalyzedExecutionTime(ARObject):
+    """
+    Represents analyzed execution time in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.executionTime: TimeValue = None
+
+    def getExecutionTime(self):
+        return self.executionTime
+
+    def setExecutionTime(self, value):
+        self.executionTime = value
+        return self
+
+
+class ExecutionTime(ARObject):
+    """
+    Represents execution time in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.executionTime: TimeValue = None
+
+    def getExecutionTime(self):
+        return self.executionTime
+
+    def setExecutionTime(self, value):
+        self.executionTime = value
+        return self
+
+
+class MeasuredExecutionTime(ARObject):
+    """
+    Represents measured execution time in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.executionTime: TimeValue = None
+        self.sampleSize: int = None
+
+    def getExecutionTime(self):
+        return self.executionTime
+
+    def setExecutionTime(self, value):
+        self.executionTime = value
+        return self
+
+    def getSampleSize(self):
+        return self.sampleSize
+
+    def setSampleSize(self, value):
+        self.sampleSize = value
+        return self
+
+
+class MemorySectionLocation(ARObject):
+    """
+    Represents memory section location in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.sectionName: str = None
+
+    def getSectionName(self):
+        return self.sectionName
+
+    def setSectionName(self, value):
+        self.sectionName = value
+        return self
+
+
+class RoughEstimateOfExecutionTime(ARObject):
+    """
+    Represents rough estimate of execution time in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.executionTime: TimeValue = None
+        self.confidenceLevel: str = None
+
+    def getExecutionTime(self):
+        return self.executionTime
+
+    def setExecutionTime(self, value):
+        self.executionTime = value
+        return self
+
+    def getConfidenceLevel(self):
+        return self.confidenceLevel
+
+    def setConfidenceLevel(self, value):
+        self.confidenceLevel = value
+        return self
+
+
+class SimulatedExecutionTime(ARObject):
+    """
+    Represents simulated execution time in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.executionTime: TimeValue = None
+        self.simulationModel: str = None
+
+    def getExecutionTime(self):
+        return self.executionTime
+
+    def setExecutionTime(self, value):
+        self.executionTime = value
+        return self
+
+    def getSimulationModel(self):
+        return self.simulationModel
+
+    def setSimulationModel(self, value):
+        self.simulationModel = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/ResourceConsumption/HardwareConfiguration.py

@@ -1,33 +1,94 @@
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import String
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-
-class HardwareConfiguration(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.additionalInformation = None                       # type: String
-        self.processorMode = None                               # type: String
-        self.processorSpeed = None                              # type: String
-
-    def getAdditionalInformation(self):
-        return self.additionalInformation
-
-    def setAdditionalInformation(self, value):
-        self.additionalInformation = value
-        return self
-
-    def getProcessorMode(self):
-        return self.processorMode
-
-    def setProcessorMode(self, value):
-        self.processorMode = value
-        return self
-
-    def getProcessorSpeed(self):
-        return self.processorSpeed
-
-    def setProcessorSpeed(self, value):
-        self.processorSpeed = value
-        return self
-
+"""
+This module contains the HardwareConfiguration class for representing
+hardware-specific configuration information in AUTOSAR resource consumption models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import String
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+class HardwareConfiguration(ARObject):
+    """
+    Represents hardware configuration information in AUTOSAR models.
+    This class defines specific hardware properties that may affect resource consumption.
+    """
+    
+    def __init__(self):
+        """
+        Initializes the HardwareConfiguration with default values.
+        """
+        super().__init__()
+
+        # Additional information about the hardware configuration
+        self.additionalInformation: String = None                       
+        # Processor mode setting for this hardware configuration
+        self.processorMode: String = None                               
+        # Processor speed for this hardware configuration              
+        self.processorSpeed: String = None                              
+
+    def getAdditionalInformation(self):
+        """
+        Gets the additional information about the hardware configuration.
+        
+        Returns:
+            String: Additional hardware configuration information
+        """
+        return self.additionalInformation
+
+    def setAdditionalInformation(self, value):
+        """
+        Sets the additional information about the hardware configuration.
+        
+        Args:
+            value: The additional information to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.additionalInformation = value
+        return self
+
+    def getProcessorMode(self):
+        """
+        Gets the processor mode setting for this hardware configuration.
+        
+        Returns:
+            String: Processor mode setting
+        """
+        return self.processorMode
+
+    def setProcessorMode(self, value):
+        """
+        Sets the processor mode setting for this hardware configuration.
+        
+        Args:
+            value: The processor mode to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.processorMode = value
+        return self
+
+    def getProcessorSpeed(self):
+        """
+        Gets the processor speed for this hardware configuration.
+        
+        Returns:
+            String: Processor speed setting
+        """
+        return self.processorSpeed
+
+    def setProcessorSpeed(self, value):
+        """
+        Sets the processor speed for this hardware configuration.
+        
+        Args:
+            value: The processor speed to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.processorSpeed = value
+        return self
+
         

armodel/models/M2/AUTOSARTemplates/CommonStructure/ResourceConsumption/HeapUsage.py

@@ -1,10 +1,78 @@
-from abc import ABCMeta
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-
-class HeapUsage(Identifiable, metaclass = ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == HeapUsage:
-            raise NotImplementedError("HeapUsage is an abstract class.")
-        
-        super().__init__(parent, short_name)
+"""
+This module contains the HeapUsage abstract class for representing
+heap memory usage in AUTOSAR resource consumption models.
+"""
+
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+class HeapUsage(Identifiable, ABC):
+    """
+    Abstract base class for representing heap usage in AUTOSAR models.
+    This class defines the basic structure for heap memory consumption tracking.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the HeapUsage with a parent and short name.
+        Raises TypeError if this abstract class is instantiated directly.
+        
+        Args:
+            parent: The parent ARObject that contains this heap usage
+            short_name: The unique short name of this heap usage
+        """
+        if type(self) == HeapUsage:
+            raise TypeError("HeapUsage is an abstract class.")
+        
+        super().__init__(parent, short_name)
+
+class MeasuredHeapUsage(HeapUsage):
+    """
+    Represents measured heap usage in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.sampleSize: int = None
+
+    def getSampleSize(self):
+        return self.sampleSize
+
+    def setSampleSize(self, value):
+        self.sampleSize = value
+        return self
+
+
+class RoughEstimateHeapUsage(HeapUsage):
+    """
+    Represents rough estimate of heap usage in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.confidenceLevel: str = None
+
+    def getConfidenceLevel(self):
+        return self.confidenceLevel
+
+    def setConfidenceLevel(self, value):
+        self.confidenceLevel = value
+        return self
+
+
+class WorstCaseHeapUsage(HeapUsage):
+    """
+    Represents worst case heap usage in AUTOSAR.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.confidenceLevel: str = None
+
+    def getConfidenceLevel(self):
+        return self.confidenceLevel
+
+    def setConfidenceLevel(self, value):
+        self.confidenceLevel = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/ResourceConsumption/MemorySectionUsage.py

@@ -1,81 +1,239 @@
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral, RefType
-import re
-from typing import List
-
-class MemorySection(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self._alignment = None              # type: ARLiteral
-        self.memClassSymbol = None          # type: ARLiteral
-        self.size = None
-        self.options = []                   # type: List[ARLiteral]
-        self.swAddrMethodRef = None         # type: RefType
-        self.symbol = None                  # type: ARLiteral
-
-    def getAlignment(self):
-        return self.alignment
-
-    def setAlignment(self, value):
-        self.alignment = value
-        return self
-    
-    def getMemClassSymbol(self):
-        return self.memClassSymbol
-
-    def setMemClassSymbol(self, value):
-        self.memClassSymbol = value
-        return self
-
-    def getSize(self):
-        return self.size
-
-    def setSize(self, value):
-        self.size = value
-        return self
-
-    def getSwAddrMethodRef(self):
-        return self.swAddrMethodRef
-
-    def setSwAddrMethodRef(self, value):
-        self.swAddrMethodRef = value
-        return self
-
-    def getSymbol(self):
-        return self.symbol
-
-    def setSymbol(self, value):
-        self.symbol = value
-        return self
-
-    @property
-    def alignment(self) -> ARLiteral:
-        return self._alignment
-
-    @alignment.setter
-    def alignment(self, value: ARLiteral):
-        '''
-        if value is not None and value.getValue() != "":
-            match = False
-            if value.getValue() in ("UNKNOWN", "UNSPECIFIED", "BOOLEAN", "PTR"):
-                self._alignment = value
-                match = True
-            else:
-                m = re.match(r'^\d+', value.value)
-                if m:
-                    self._alignment = value
-                    match = True
-
-            if not match:
-                raise ValueError("Invalid alignment <%s> of memory section <%s>" % (value, self.getShortName()))
-        '''
-        if value is not None:
-            self._alignment = value
-
-    def addOption(self, option: ARLiteral):
-        self.options.append(option)
-
-    def getOptions(self) -> List[ARLiteral]:
-        return self.options
+"""
+This module contains the MemorySection class for representing
+memory section usage in AUTOSAR resource consumption models.
+"""
+
+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 ARLiteral, RefType
+from typing import List
+
+class MemorySection(Identifiable):
+    """
+    Represents a memory section in AUTOSAR models.
+    This class defines memory section properties including alignment, size, and addressing methods.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the MemorySection with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this memory section
+            short_name: The unique short name of this memory section
+        """
+        super().__init__(parent, short_name)
+
+        # Private alignment value for this memory section
+        self._alignment: ARLiteral = None              
+        # Memory class symbol for this memory section
+        self.memClassSymbol: ARLiteral = None          
+        # Size of this memory section
+        self.size = None
+        # List of options for this memory section
+        self.options: List[ARLiteral] = []                   
+        # Reference to the software address method for this memory section
+        self.swAddrMethodRef: RefType = None         
+        # Symbol name for this memory section
+        self.symbol: ARLiteral = None                  
+
+    def getAlignment(self):
+        """
+        Gets the alignment value for this memory section through the property getter.
+        
+        Returns:
+            ARLiteral: Alignment value
+        """
+        return self.alignment
+
+    def setAlignment(self, value):
+        """
+        Sets the alignment value for this memory section through the property setter.
+        
+        Args:
+            value: The alignment value to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.alignment = value
+        return self
+    
+    def getMemClassSymbol(self):
+        """
+        Gets the memory class symbol for this memory section.
+        
+        Returns:
+            ARLiteral: Memory class symbol
+        """
+        return self.memClassSymbol
+
+    def setMemClassSymbol(self, value):
+        """
+        Sets the memory class symbol for this memory section.
+        
+        Args:
+            value: The memory class symbol to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.memClassSymbol = value
+        return self
+
+    def getSize(self):
+        """
+        Gets the size of this memory section.
+        
+        Returns:
+            Size value of the memory section
+        """
+        return self.size
+
+    def setSize(self, value):
+        """
+        Sets the size of this memory section.
+        
+        Args:
+            value: The size value to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.size = value
+        return self
+
+    def getSwAddrMethodRef(self):
+        """
+        Gets the reference to the software address method for this memory section.
+        
+        Returns:
+            RefType: Reference to the software address method
+        """
+        return self.swAddrMethodRef
+
+    def setSwAddrMethodRef(self, value):
+        """
+        Sets the reference to the software address method for this memory section.
+        
+        Args:
+            value: The reference to the software address method to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.swAddrMethodRef = value
+        return self
+
+    def getSymbol(self):
+        """
+        Gets the symbol name for this memory section.
+        
+        Returns:
+            ARLiteral: Symbol name
+        """
+        return self.symbol
+
+    def setSymbol(self, value):
+        """
+        Sets the symbol name for this memory section.
+        
+        Args:
+            value: The symbol name to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.symbol = value
+        return self
+
+    @property
+    def alignment(self) -> ARLiteral:
+        """
+        Gets the alignment value for this memory section.
+        
+        Returns:
+            ARLiteral: Alignment value
+        """
+        return self._alignment
+
+    @alignment.setter
+    def alignment(self, value: ARLiteral):
+        """
+        Sets the alignment value for this memory section with validation.
+        Note: The validation code is commented out but kept for reference.
+        
+        Args:
+            value: The alignment value to set
+        """
+        r'''
+        if value is not None and value.getValue() != "":
+            match = False
+            if value.getValue() in ("UNKNOWN", "UNSPECIFIED", "BOOLEAN", "PTR"):
+                self._alignment = value
+                match = True
+            else:
+                m = re.match(r'^\d+', value.value)
+                if m:
+                    self._alignment = value
+                    match = True
+
+            if not match:
+                raise ValueError("Invalid alignment <%s> of memory section <%s>" % (value, self.getShortName()))
+        '''
+        if value is not None:
+            self._alignment = value
+
+    def addOption(self, option: ARLiteral):
+        """
+        Adds an option to the list of options for this memory section.
+        
+        Args:
+            option: The option to add
+        """
+        self.options.append(option)
+
+    def getOptions(self) -> List[ARLiteral]:
+        """
+        Gets the list of options for this memory section.
+        
+        Returns:
+            List of ARLiteral options
+        """
+        return self.options
+
+
+class SectionNamePrefix(ARObject):
+    """
+    Represents a section name prefix in AUTOSAR memory section usage.
+    Defines a prefix for memory section names.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SectionNamePrefix with default values.
+        """
+        super().__init__()
+        self.prefix: str = None
+
+    def getPrefix(self) -> str:
+        """
+        Gets the section name prefix.
+
+        Returns:
+            String representing the prefix
+        """
+        return self.prefix
+
+    def setPrefix(self, value: str):
+        """
+        Sets the section name prefix.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.prefix = value
+        return self