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

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

@@ -1,96 +1,243 @@
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import AREnum, PositiveInteger, UnlimitedInteger
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-
-
-class DataFilterTypeEnum(AREnum):
-
-    MASKED_NEW_DIFFERS_MASKED_OLD = "maskedNewDiffersMaskedOld"
-    MASKED_NEW_DIFFERS_X = "maskedNewDiffersX"
-    MASKED_NEW_EQUALS_X = "maskedNewEqualsX"
-    NEVER = "never"
-    NEW_IS_OUTSIDE = "newIsOutside"
-    NEW_IS_WITHIN = "newIsWithin"
-    ONE_EVERY_N = "oneEveryN"
-
-    def __init__(self):
-        super().__init__((
-            DataFilterTypeEnum.MASKED_NEW_DIFFERS_MASKED_OLD,
-            DataFilterTypeEnum.MASKED_NEW_DIFFERS_X,
-            DataFilterTypeEnum.MASKED_NEW_EQUALS_X, 
-            DataFilterTypeEnum.NEVER,
-            DataFilterTypeEnum.NEW_IS_OUTSIDE,
-            DataFilterTypeEnum.NEW_IS_WITHIN,
-            DataFilterTypeEnum.ONE_EVERY_N
-        ))
-
-
-class DataFilter(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.dataFilterType = None                  # type: DataFilterTypeEnum
-        self.mask = None                            # type: UnlimitedInteger
-        self.max = None                             # type: UnlimitedInteger
-        self.min = None                             # type: UnlimitedInteger
-        self.offset = None                          # type: PositiveInteger
-        self.period = None                          # type: PositiveInteger
-        self.x = None                               # type: UnlimitedInteger
-
-    def getDataFilterType(self):
-        return self.dataFilterType
-
-    def setDataFilterType(self, value):
-        if value is not None:
-            self.dataFilterType = value
-        return self
-
-    def getMask(self):
-        return self.mask
-
-    def setMask(self, value):
-        if value is not None:
-            self.mask = value
-        return self
-
-    def getMax(self):
-        return self.max
-
-    def setMax(self, value):
-        if value is not None:
-            self.max = value
-        return self
-
-    def getMin(self):
-        return self.min
-
-    def setMin(self, value):
-        if value is not None:
-            self.min = value
-        return self
-
-    def getOffset(self):
-        return self.offset
-
-    def setOffset(self, value):
-        if value is not None:
-            self.offset = value
-        return self
-
-    def getPeriod(self):
-        return self.period
-
-    def setPeriod(self, value):
-        if value is not None:
-            self.period = value
-        return self
-
-    def getX(self):
-        return self.x
-
-    def setX(self, value):
-        if value is not None:
-            self.x = value
-        return self
-
-
-    
+"""
+This module contains classes for representing AUTOSAR data filter configurations
+in the CommonStructure module. Data filters are used to define conditions for
+data processing, such as when to update values based on filters or limits.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import AREnum, PositiveInteger, UnlimitedInteger
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+
+class DataFilterTypeEnum(AREnum):
+    """
+    Enumeration for data filter types in AUTOSAR models.
+    Defines various filtering strategies for data processing in AUTOSAR systems.
+    """
+
+    # Filter condition: new value with mask differs from old value with mask
+    MASKED_NEW_DIFFERS_MASKED_OLD = "maskedNewDiffersMaskedOld"
+    # Filter condition: new value with mask differs from reference value X
+    MASKED_NEW_DIFFERS_X = "maskedNewDiffersX"
+    # Filter condition: new value with mask equals reference value X
+    MASKED_NEW_EQUALS_X = "maskedNewEqualsX"
+    # Filter condition: never update (no filtering)
+    NEVER = "never"
+    # Filter condition: new value is outside specified range
+    NEW_IS_OUTSIDE = "newIsOutside"
+    # Filter condition: new value is within specified range
+    NEW_IS_WITHIN = "newIsWithin"
+    # Filter condition: update every N occurrences
+    ONE_EVERY_N = "oneEveryN"
+
+    def __init__(self):
+        """
+        Initializes the DataFilterTypeEnum with all possible values.
+        """
+        super().__init__((
+            DataFilterTypeEnum.MASKED_NEW_DIFFERS_MASKED_OLD,
+            DataFilterTypeEnum.MASKED_NEW_DIFFERS_X,
+            DataFilterTypeEnum.MASKED_NEW_EQUALS_X, 
+            DataFilterTypeEnum.NEVER,
+            DataFilterTypeEnum.NEW_IS_OUTSIDE,
+            DataFilterTypeEnum.NEW_IS_WITHIN,
+            DataFilterTypeEnum.ONE_EVERY_N
+        ))
+
+
+class DataFilter(ARObject):
+    """
+    Represents a data filter configuration in AUTOSAR models.
+    This class defines conditions and parameters for filtering data updates in AUTOSAR systems.
+    """
+    
+    def __init__(self):
+        """
+        Initializes the DataFilter with default values.
+        """
+        super().__init__()
+
+        # Type of data filtering to apply
+        self.dataFilterType: DataFilterTypeEnum = None                  
+        # Bit mask for masked filtering operations
+        self.mask: UnlimitedInteger = None                            
+        # Maximum threshold value for range-based filtering
+        self.max: UnlimitedInteger = None                             
+        # Minimum threshold value for range-based filtering
+        self.min: UnlimitedInteger = None                             
+        # Offset value for filtering calculations
+        self.offset: PositiveInteger = None                          
+        # Period for periodic filtering operations (e.g., oneEveryN)
+        self.period: PositiveInteger = None                          
+        # Reference value X used in comparison-based filtering
+        self.x: UnlimitedInteger = None                               
+
+    def getDataFilterType(self):
+        """
+        Gets the type of data filtering to apply.
+        
+        Returns:
+            DataFilterTypeEnum: The data filter type
+        """
+        return self.dataFilterType
+
+    def setDataFilterType(self, value):
+        """
+        Sets the type of data filtering to apply.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The data filter type to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.dataFilterType = value
+        return self
+
+    def getMask(self):
+        """
+        Gets the bit mask for masked filtering operations.
+        
+        Returns:
+            UnlimitedInteger: The bit mask
+        """
+        return self.mask
+
+    def setMask(self, value):
+        """
+        Sets the bit mask for masked filtering operations.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The bit mask to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.mask = value
+        return self
+
+    def getMax(self):
+        """
+        Gets the maximum threshold value for range-based filtering.
+        
+        Returns:
+            UnlimitedInteger: The maximum threshold
+        """
+        return self.max
+
+    def setMax(self, value):
+        """
+        Sets the maximum threshold value for range-based filtering.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The maximum threshold to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.max = value
+        return self
+
+    def getMin(self):
+        """
+        Gets the minimum threshold value for range-based filtering.
+        
+        Returns:
+            UnlimitedInteger: The minimum threshold
+        """
+        return self.min
+
+    def setMin(self, value):
+        """
+        Sets the minimum threshold value for range-based filtering.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The minimum threshold to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.min = value
+        return self
+
+    def getOffset(self):
+        """
+        Gets the offset value for filtering calculations.
+        
+        Returns:
+            PositiveInteger: The offset value
+        """
+        return self.offset
+
+    def setOffset(self, value):
+        """
+        Sets the offset value for filtering calculations.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The offset value to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.offset = value
+        return self
+
+    def getPeriod(self):
+        """
+        Gets the period for periodic filtering operations (e.g., oneEveryN).
+        
+        Returns:
+            PositiveInteger: The period value
+        """
+        return self.period
+
+    def setPeriod(self, value):
+        """
+        Sets the period for periodic filtering operations (e.g., oneEveryN).
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The period value to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.period = value
+        return self
+
+    def getX(self):
+        """
+        Gets the reference value X used in comparison-based filtering.
+        
+        Returns:
+            UnlimitedInteger: The reference value X
+        """
+        return self.x
+
+    def setX(self, value):
+        """
+        Sets the reference value X used in comparison-based filtering.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The reference value X to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.x = value
+        return self
+
+
+    

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

@@ -1,69 +1,273 @@
-from typing import List
-from ....M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Identifier
-from ....M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AnyInstanceRef
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement, Identifiable
-
-
-class FlatInstanceDescriptor(Identifiable):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-        
-        self.ecuExtractReferenceIRef = None                     # type: AnyInstanceRef
-        self.role = None                                        # type: Identifier
-        self.rtePluginProps = None                              # type: RtePluginProps
-        self.swDataDefProps = None                              # type: SwDataDefProps
-        self.upstreamReferenceIRef = None                       # type: AnyInstanceRef
-
-    def getEcuExtractReferenceIRef(self):
-        return self.ecuExtractReferenceIRef
-
-    def setEcuExtractReferenceIRef(self, value):
-        self.ecuExtractReferenceIRef = value
-        return self
-
-    def getRole(self):
-        return self.role
-
-    def setRole(self, value):
-        self.role = value
-        return self
-
-    def getRtePluginProps(self):
-        return self.rtePluginProps
-
-    def setRtePluginProps(self, value):
-        self.rtePluginProps = value
-        return self
-
-    def getSwDataDefProps(self):
-        return self.swDataDefProps
-
-    def setSwDataDefProps(self, value):
-        self.swDataDefProps = value
-        return self
-
-    def getUpstreamReferenceIRef(self):
-        return self.upstreamReferenceIRef
-
-    def setUpstreamReferenceIRef(self, value):
-        self.upstreamReferenceIRef = value
-        return self
-
-
-class FlatMap(ARElement):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.instances = []                                 # type: List[FlatInstanceDescriptor]
-
-    def getInstances(self):
-        return list(sorted(filter(lambda a: isinstance(a, FlatInstanceDescriptor), self.elements), key=lambda o: o.short_name))
-
-    def createFlatInstanceDescriptor(self, short_name: str):
-        if (short_name not in self.elements):
-            element = FlatInstanceDescriptor(self, short_name)
-            self.addElement(element)
-            self.instances.append(element)
-        return self.getElement(short_name)
+"""
+This module contains classes for representing AUTOSAR flat map structures
+in the CommonStructure module. Flat maps are used to describe instance
+hierarchies in a flat manner, typically used for code generation purposes.
+"""
+
+from typing import List
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpBlueprintable
+from armodel.models.M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Identifier
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.AnyInstanceRef import AnyInstanceRef
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement, Identifiable
+
+
+class FlatInstanceDescriptor(Identifiable):
+    """
+    Represents a flat instance descriptor in AUTOSAR models.
+    This class describes a single instance in a flattened instance hierarchy, typically used for code generation.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the FlatInstanceDescriptor with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this instance descriptor
+            short_name: The unique short name of this instance descriptor
+        """
+        super().__init__(parent, short_name)
+        
+        # Instance reference to ECU extract reference
+        self.ecuExtractReferenceIRef: AnyInstanceRef = None                     
+        # Role identifier for this instance descriptor
+        self.role: Identifier = None                                        
+        # RTE plugin properties for this instance (forward reference)
+        self.rtePluginProps = None                              
+        # Software data definition properties for this instance
+        self.swDataDefProps: SwDataDefProps = None                              
+        # Upstream instance reference for this instance descriptor
+        self.upstreamReferenceIRef: AnyInstanceRef = None                       
+
+    def getEcuExtractReferenceIRef(self):
+        """
+        Gets the instance reference to ECU extract reference.
+        
+        Returns:
+            AnyInstanceRef: The ECU extract reference instance reference
+        """
+        return self.ecuExtractReferenceIRef
+
+    def setEcuExtractReferenceIRef(self, value):
+        """
+        Sets the instance reference to ECU extract reference.
+        
+        Args:
+            value: The ECU extract reference instance reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.ecuExtractReferenceIRef = value
+        return self
+
+    def getRole(self):
+        """
+        Gets the role identifier for this instance descriptor.
+        
+        Returns:
+            Identifier: The role identifier
+        """
+        return self.role
+
+    def setRole(self, value):
+        """
+        Sets the role identifier for this instance descriptor.
+        
+        Args:
+            value: The role identifier to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.role = value
+        return self
+
+    def getRtePluginProps(self):
+        """
+        Gets the RTE plugin properties for this instance.
+        
+        Returns:
+            RtePluginProps: The RTE plugin properties
+        """
+        return self.rtePluginProps
+
+    def setRtePluginProps(self, value):
+        """
+        Sets the RTE plugin properties for this instance.
+        
+        Args:
+            value: The RTE plugin properties to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.rtePluginProps = value
+        return self
+
+    def getSwDataDefProps(self):
+        """
+        Gets the software data definition properties for this instance.
+        
+        Returns:
+            SwDataDefProps: The software data definition properties
+        """
+        return self.swDataDefProps
+
+    def setSwDataDefProps(self, value):
+        """
+        Sets the software data definition properties for this instance.
+        
+        Args:
+            value: The software data definition properties to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.swDataDefProps = value
+        return self
+
+    def getUpstreamReferenceIRef(self):
+        """
+        Gets the upstream instance reference for this instance descriptor.
+        
+        Returns:
+            AnyInstanceRef: The upstream reference instance reference
+        """
+        return self.upstreamReferenceIRef
+
+    def setUpstreamReferenceIRef(self, value):
+        """
+        Sets the upstream instance reference for this instance descriptor.
+        
+        Args:
+            value: The upstream reference instance reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.upstreamReferenceIRef = value
+        return self
+
+
+class FlatMap(AtpBlueprintable):
+    """
+    Represents a flat map in AUTOSAR models.
+    This class contains a collection of flat instance descriptors that define a flattened view of instance hierarchies.
+    """
+    
+    def __init__(self, parent: ARObject, short_name: str):
+        """
+        Initializes the FlatMap with a parent and short name.
+        
+        Args:
+            parent: The parent ARObject that contains this flat map
+            short_name: The unique short name of this flat map
+        """
+        super().__init__(parent, short_name)
+
+        # List of flat instance descriptors in this flat map
+        self.instances: List['FlatInstanceDescriptor'] = []
+
+    def getInstances(self):
+        """
+        Gets all flat instance descriptors from the elements list, sorted by short name.
+        
+        Returns:
+            List of FlatInstanceDescriptor instances sorted by short name
+        """
+        return list(sorted(filter(lambda a: isinstance(a, FlatInstanceDescriptor), self.elements), key=lambda o: o.short_name))
+
+    def createFlatInstanceDescriptor(self, short_name: str):
+        """
+        Creates and adds a FlatInstanceDescriptor to this flat map.
+        
+        Args:
+            short_name: The short name for the new instance descriptor
+            
+        Returns:
+            The created FlatInstanceDescriptor instance
+        """
+        if (short_name not in self.elements):
+            element = FlatInstanceDescriptor(self, short_name)
+            self.addElement(element)
+            self.instances.append(element)
+        return self.getElement(short_name)
+
+
+class AliasNameAssignment(ARObject):
+    """
+    Represents an alias name assignment in AUTOSAR.
+    This class defines how aliases are assigned to elements.
+    """
+
+    def __init__(self):
+        """
+        Initializes the AliasNameAssignment with default values.
+        """
+        super().__init__()
+        self.aliasName: str = None
+        self.elementRef: AnyInstanceRef = None
+
+    def getAliasName(self):
+        return self.aliasName
+
+    def setAliasName(self, value):
+        self.aliasName = value
+        return self
+
+    def getElementRef(self):
+        return self.elementRef
+
+    def setElementRef(self, value):
+        self.elementRef = value
+        return self
+
+
+class AliasNameSet(ARObject):
+    """
+    Represents a set of alias name assignments.
+    """
+
+    def __init__(self):
+        """
+        Initializes the AliasNameSet with default values.
+        """
+        super().__init__()
+        self.aliases = []
+
+    def addAlias(self, alias):
+        self.aliases.append(alias)
+
+    def getAliases(self):
+        return self.aliases
+
+
+class RtePluginProps(ARObject):
+    """
+    Represents RTE plugin properties in AUTOSAR.
+    This class defines properties for RTE plugins.
+    """
+
+    def __init__(self):
+        """
+        Initializes the RtePluginProps with default values.
+        """
+        super().__init__()
+        self.pluginName: str = None
+        self.pluginVersion: str = None
+
+    def getPluginName(self):
+        return self.pluginName
+
+    def setPluginName(self, value):
+        self.pluginName = value
+        return self
+
+    def getPluginVersion(self):
+        return self.pluginVersion
+
+    def setPluginVersion(self, value):
+        self.pluginVersion = value
+        return self