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

armodel/models/M2/AUTOSARTemplates/GenericStructure/LifeCycles.py

@@ -1,155 +1,395 @@
-from typing import List
-from xmlrpc.client import DateTime
-
-from ....M2.MSR.Documentation.TextModel.BlockElements import DocumentationBlock
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType, RevisionLabelString
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-
-
-class LifeCyclePeriod(ARObject):
-    '''
-        This meta class represents the ability to specify a point of time within a specified period, e.g. the starting
-        or end point, in which a specific life cycle state is valid/applies to.
-    '''
-    def __init__(self):
-        super().__init__()
-
-        self.arReleaseVersion = None                            # type: RevisionLabelString
-        self.date = None                                        # type: DateTime
-        self.productRelease = None                              # type: RevisionLabelString
-
-    def getArReleaseVersion(self):
-        return self.arReleaseVersion
-
-    def setArReleaseVersion(self, value):
-        if value is not None:
-            self.arReleaseVersion = value
-        return self
-
-    def getDate(self):
-        return self.date
-
-    def setDate(self, value):
-        if value is not None:
-            self.date = value
-        return self
-
-    def getProductRelease(self):
-        return self.productRelease
-
-    def setProductRelease(self, value):
-        if value is not None:
-            self.productRelease = value
-        return self
-
-
-class LifeCycleInfo(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.lcObjectRef = None                                 # type: RefType
-        self.lcStateRef = None                                  # type: RefType
-        self.periodBegin = None                                 # type: LifeCyclePeriod
-        self.periodEnd = None                                   # type: LifeCyclePeriod
-        self.remark = None                                      # type: DocumentationBlock
-        self.useInsteadRefs = []                                # type: List[RefType]
-
-    def getLcObjectRef(self):
-        return self.lcObjectRef
-
-    def setLcObjectRef(self, value):
-        if value is not None:
-            self.lcObjectRef = value
-        return self
-
-    def getLcStateRef(self):
-        return self.lcStateRef
-
-    def setLcStateRef(self, value):
-        if value is not None:
-            self.lcStateRef = value
-        return self
-
-    def getPeriodBegin(self):
-        return self.periodBegin
-
-    def setPeriodBegin(self, value):
-        if value is not None:
-            self.periodBegin = value
-        return self
-
-    def getPeriodEnd(self):
-        return self.periodEnd
-
-    def setPeriodEnd(self, value):
-        if value is not None:
-            self.periodEnd = value
-        return self
-
-    def getRemark(self):
-        return self.remark
-
-    def setRemark(self, value):
-        if value is not None:
-            self.remark = value
-        return self
-
-    def getUseInsteadRefs(self):
-        return self.useInsteadRefs
-
-    def addUseInsteadRef(self, value):
-        if value is not None:
-            self.useInsteadRefs.append(value)
-        return self
-
-
-class LifeCycleInfoSet(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.defaultLcStateRef = None                           # type: RefType
-        self.defaultPeriodBegin = None                          # type: LifeCyclePeriod
-        self.defaultPeriodEnd = None                            # type: LifeCyclePeriod
-        self.lifeCycleInfos = []                                # type: List[LifeCycleInfo]
-        self.usedLifeCycleStateDefinitionGroupRef = None        # type: RefType
-
-    def getDefaultLcStateRef(self):
-        return self.defaultLcStateRef
-
-    def setDefaultLcStateRef(self, value):
-        if value is not None:
-            self.defaultLcStateRef = value
-        return self
-
-    def getDefaultPeriodBegin(self):
-        return self.defaultPeriodBegin
-
-    def setDefaultPeriodBegin(self, value):
-        if value is not None:
-            self.defaultPeriodBegin = value
-        return self
-
-    def getDefaultPeriodEnd(self):
-        return self.defaultPeriodEnd
-
-    def setDefaultPeriodEnd(self, value):
-        if value is not None:
-            self.defaultPeriodEnd = value
-        return self
-
-    def getLifeCycleInfos(self):
-        return self.lifeCycleInfos
-
-    def addLifeCycleInfo(self, value):
-        if value is not None:
-            self.lifeCycleInfos.append(value)
-        return self
-
-    def getUsedLifeCycleStateDefinitionGroupRef(self):
-        return self.usedLifeCycleStateDefinitionGroupRef
-
-    def setUsedLifeCycleStateDefinitionGroupRef(self, value):
-        if value is not None:
-            self.usedLifeCycleStateDefinitionGroupRef = value
-        return self
+"""
+This module contains classes for representing AUTOSAR life cycle information
+in the GenericStructure module.
+"""
+
+from typing import List, Optional
+from datetime import datetime
+
+from armodel.models.M2.MSR.Documentation.TextModel.BlockElements import DocumentationBlock
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType, RevisionLabelString
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
+
+
+class LifeCyclePeriod(ARObject):
+    '''
+        This meta class represents the ability to specify a point of time within a specified period, e.g. the starting
+        or end point, in which a specific life cycle state is valid/applies to.
+    '''
+    
+    def __init__(self):
+        super().__init__()
+
+        self.arReleaseVersion: Optional[RevisionLabelString] = None
+        self.date: Optional[datetime] = None
+        self.productRelease: Optional[RevisionLabelString] = None
+
+    def getArReleaseVersion(self) -> Optional[RevisionLabelString]:
+        """
+        Gets the AUTOSAR release version for this life cycle period.
+        
+        Returns:
+            RevisionLabelString representing the AUTOSAR release version, or None if not set
+        """
+        return self.arReleaseVersion
+
+    def setArReleaseVersion(self, value: RevisionLabelString):
+        """
+        Sets the AUTOSAR release version for this life cycle period.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The AUTOSAR release version to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.arReleaseVersion = value
+        return self
+
+    def getDate(self) -> Optional[datetime]:
+        """
+        Gets the date for this life cycle period.
+        
+        Returns:
+            datetime object representing the date, or None if not set
+        """
+        return self.date
+
+    def setDate(self, value: datetime):
+        """
+        Sets the date for this life cycle period.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The date to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.date = value
+        return self
+
+    def getProductRelease(self) -> Optional[RevisionLabelString]:
+        """
+        Gets the product release for this life cycle period.
+        
+        Returns:
+            RevisionLabelString representing the product release, or None if not set
+        """
+        return self.productRelease
+
+    def setProductRelease(self, value: RevisionLabelString):
+        """
+        Sets the product release for this life cycle period.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The product release to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.productRelease = value
+        return self
+
+
+class LifeCycleInfo(ARObject):
+    """
+    Represents life cycle information in AUTOSAR models.
+    This class defines information about the life cycle of AUTOSAR elements.
+    """
+    
+    def __init__(self):
+        super().__init__()
+
+        self.lcObjectRef: Optional[RefType] = None
+        self.lcStateRef: Optional[RefType] = None
+        self.periodBegin: Optional[LifeCyclePeriod] = None
+        self.periodEnd: Optional[LifeCyclePeriod] = None
+        self.remark: Optional[DocumentationBlock] = None
+        self.useInsteadRefs: List[RefType] = []
+
+    def getLcObjectRef(self) -> Optional[RefType]:
+        """
+        Gets the life cycle object reference.
+        
+        Returns:
+            RefType representing the life cycle object reference, or None if not set
+        """
+        return self.lcObjectRef
+
+    def setLcObjectRef(self, value: RefType):
+        """
+        Sets the life cycle object reference.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The life cycle object reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.lcObjectRef = value
+        return self
+
+    def getLcStateRef(self) -> Optional[RefType]:
+        """
+        Gets the life cycle state reference.
+        
+        Returns:
+            RefType representing the life cycle state reference, or None if not set
+        """
+        return self.lcStateRef
+
+    def setLcStateRef(self, value: RefType):
+        """
+        Sets the life cycle state reference.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The life cycle state reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.lcStateRef = value
+        return self
+
+    def getPeriodBegin(self) -> Optional[LifeCyclePeriod]:
+        """
+        Gets the beginning period of the life cycle.
+        
+        Returns:
+            LifeCyclePeriod representing the beginning period, or None if not set
+        """
+        return self.periodBegin
+
+    def setPeriodBegin(self, value: LifeCyclePeriod):
+        """
+        Sets the beginning period of the life cycle.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The beginning period to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.periodBegin = value
+        return self
+
+    def getPeriodEnd(self) -> Optional[LifeCyclePeriod]:
+        """
+        Gets the ending period of the life cycle.
+        
+        Returns:
+            LifeCyclePeriod representing the ending period, or None if not set
+        """
+        return self.periodEnd
+
+    def setPeriodEnd(self, value: LifeCyclePeriod):
+        """
+        Sets the ending period of the life cycle.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The ending period to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.periodEnd = value
+        return self
+
+    def getRemark(self) -> Optional[DocumentationBlock]:
+        """
+        Gets the remark documentation for this life cycle information.
+        
+        Returns:
+            DocumentationBlock instance, or None if not set
+        """
+        return self.remark
+
+    def setRemark(self, value: DocumentationBlock):
+        """
+        Sets the remark documentation for this life cycle information.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The remark documentation to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.remark = value
+        return self
+
+    def getUseInsteadRefs(self) -> List[RefType]:
+        """
+        Gets the list of "use instead" references.
+        
+        Returns:
+            List of RefType instances
+        """
+        return self.useInsteadRefs
+
+    def addUseInsteadRef(self, value: RefType):
+        """
+        Adds a "use instead" reference.
+        Only adds the value if it is not None.
+        
+        Args:
+            value: The "use instead" reference to add
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.useInsteadRefs.append(value)
+        return self
+
+
+class LifeCycleInfoSet(ARElement):
+    """
+    Represents a set of life cycle information in AUTOSAR models.
+    This class organizes and manages multiple life cycle information entries.
+    """
+    
+    def __init__(self, parent, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.defaultLcStateRef: Optional[RefType] = None
+        self.defaultPeriodBegin: Optional[LifeCyclePeriod] = None
+        self.defaultPeriodEnd: Optional[LifeCyclePeriod] = None
+        self.lifeCycleInfos: List[LifeCycleInfo] = []
+        self.usedLifeCycleStateDefinitionGroupRef: Optional[RefType] = None
+
+    def getDefaultLcStateRef(self) -> Optional[RefType]:
+        """
+        Gets the default life cycle state reference.
+        
+        Returns:
+            RefType representing the default life cycle state reference, or None if not set
+        """
+        return self.defaultLcStateRef
+
+    def setDefaultLcStateRef(self, value: RefType):
+        """
+        Sets the default life cycle state reference.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The default life cycle state reference to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.defaultLcStateRef = value
+        return self
+
+    def getDefaultPeriodBegin(self) -> Optional[LifeCyclePeriod]:
+        """
+        Gets the default beginning period.
+        
+        Returns:
+            LifeCyclePeriod representing the default beginning period, or None if not set
+        """
+        return self.defaultPeriodBegin
+
+    def setDefaultPeriodBegin(self, value: LifeCyclePeriod):
+        """
+        Sets the default beginning period.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The default beginning period to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.defaultPeriodBegin = value
+        return self
+
+    def getDefaultPeriodEnd(self) -> Optional[LifeCyclePeriod]:
+        """
+        Gets the default ending period.
+        
+        Returns:
+            LifeCyclePeriod representing the default ending period, or None if not set
+        """
+        return self.defaultPeriodEnd
+
+    def setDefaultPeriodEnd(self, value: LifeCyclePeriod):
+        """
+        Sets the default ending period.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The default ending period to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.defaultPeriodEnd = value
+        return self
+
+    def getLifeCycleInfos(self) -> List[LifeCycleInfo]:
+        """
+        Gets the list of life cycle information entries.
+        
+        Returns:
+            List of LifeCycleInfo instances
+        """
+        return self.lifeCycleInfos
+
+    def addLifeCycleInfo(self, value: LifeCycleInfo):
+        """
+        Adds a life cycle information entry.
+        Only adds the value if it is not None.
+        
+        Args:
+            value: The life cycle information entry to add
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.lifeCycleInfos.append(value)
+        return self
+
+    def getUsedLifeCycleStateDefinitionGroupRef(self) -> Optional[RefType]:
+        """
+        Gets the reference to used life cycle state definition group.
+        
+        Returns:
+            RefType representing the reference to used life cycle state definition group, or None if not set
+        """
+        return self.usedLifeCycleStateDefinitionGroupRef
+
+    def setUsedLifeCycleStateDefinitionGroupRef(self, value: RefType):
+        """
+        Sets the reference to used life cycle state definition group.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The reference to used life cycle state definition group to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.usedLifeCycleStateDefinitionGroupRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/GenericStructure/RolesAndRights/AtpDefinition.py

@@ -0,0 +1,36 @@
+"""
+This module contains the AtpDefinition abstract class for AUTOSAR models
+in the GenericStructure module.
+"""
+
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class AtpDefinition(Identifiable, ABC):
+    """
+    Abstract base class for AUTOSAR Template (ATP) definition elements.
+
+    AtpDefinition represents definition elements in the AUTOSAR system. Definitions
+    provide formal specifications or constraints that define characteristics or
+    behavior of AUTOSAR elements.
+
+    This class extends Identifiable with definition-specific functionality for
+    managing definition-based elements.
+
+    Note:
+        This is an abstract class and cannot be instantiated directly.
+        AtpDefinition is the parent of various AUTOSAR definition elements:
+        - HwCategory (hardware element categories)
+        - SwSystemconst (system constants)
+        - PostBuildVariantCriterion (post-build variant criteria)
+
+    Attributes:
+        Inherits all attributes from Identifiable including shortName, adminData,
+        longName, category, and reference management capabilities.
+    """
+
+    def __init__(self, parent, short_name: str):
+        if type(self) is AtpDefinition:
+            raise TypeError("AtpDefinition is an abstract class.")
+        super().__init__(parent, short_name)

armodel/models/M2/AUTOSARTemplates/GenericStructure/RolesAndRights/__init__.py

@@ -0,0 +1,7 @@
+"""
+RolesAndRights module for AUTOSAR M2 models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.RolesAndRights.AtpDefinition import AtpDefinition
+
+__all__ = ['AtpDefinition']

armodel/models/M2/AUTOSARTemplates/GenericStructure/VariantHandling/AttributeValueVariationPoints/__init__.py

@@ -0,0 +1,36 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Float
+
+
+class NumericalValueVariationPoint(ARObject):
+    """
+    Represents a numerical value variation point in the AUTOSAR model.
+
+    This class is used to define variation points for numerical values,
+    allowing for different values based on variant conditions.
+
+    Attributes:
+        defaultValue (Float): The default value.
+        variantValue (Float): The variant value.
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.defaultValue: Float = None
+        self.variantValue: Float = None
+
+    def getDefaultValue(self) -> Float:
+        return self.defaultValue
+
+    def setDefaultValue(self, value: Float):
+        if value is not None:
+            self.defaultValue = value
+        return self
+
+    def getVariantValue(self) -> Float:
+        return self.variantValue
+
+    def setVariantValue(self, value: Float):
+        if value is not None:
+            self.variantValue = value
+        return self