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

armodel/models/M2/AUTOSARTemplates/GenericStructure/GeneralTemplateClasses/AnyInstanceRef.py

@@ -0,0 +1,88 @@
+"""
+This module contains the AnyInstanceRef class for AUTOSAR models
+in the GenericStructure module.
+"""
+
+from typing import List, Optional
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpInstanceRef
+
+
+class AnyInstanceRef(AtpInstanceRef):
+    """
+    Represents a generic instance reference in AUTOSAR models.
+    This class defines the structure for referencing any type of instance.
+    """
+
+    def __init__(self):
+        super().__init__()
+
+        self.baseRef: Optional[RefType] = None
+        self.contextElementRefs: List[RefType] = []
+        self.targetRef: Optional[RefType] = None
+
+    def getBaseRef(self) -> Optional[RefType]:
+        """
+        Gets the base reference.
+
+        Returns:
+            RefType representing the base reference, or None if not set
+        """
+        return self.baseRef
+
+    def setBaseRef(self, value: RefType):
+        """
+        Sets the base reference.
+
+        Args:
+            value: The base reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.baseRef = value
+        return self
+
+    def getContextElementRefs(self) -> List[RefType]:
+        """
+        Gets the list of context element references.
+
+        Returns:
+            List of RefType instances representing context element references
+        """
+        return self.contextElementRefs
+
+    def addContextElementRef(self, value: RefType):
+        """
+        Adds a context element reference.
+
+        Args:
+            value: The context element reference to add
+
+        Returns:
+            self for method chaining
+        """
+        self.contextElementRefs.append(value)
+        return self
+
+    def getTargetRef(self) -> Optional[RefType]:
+        """
+        Gets the target reference.
+
+        Returns:
+            RefType representing the target reference, or None if not set
+        """
+        return self.targetRef
+
+    def setTargetRef(self, value: RefType):
+        """
+        Sets the target reference.
+
+        Args:
+            value: The target reference to set
+
+        Returns:
+            self for method chaining
+        """
+        self.targetRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/GenericStructure/GeneralTemplateClasses/ArObject.py

@@ -1,17 +1,37 @@
-from abc import ABCMeta
-from typing import Dict
-
-
-class ARObject(metaclass=ABCMeta):
-    def __init__(self):
-        if type(self) is ARObject:
-            raise TypeError("ARObject is an abstract class.")
-
-        self.parent = None              # type: ARObject
-        self.checksum = None            # type: str
-
-        self.timestamp = None           # type: str
-        self.uuid = None                # type: str
-
-    def getTagName(self, tag: str, nsmap: Dict) -> str:
-        return tag.replace("{%s}" % nsmap["xmlns"], "")
+"""
+This module contains the base ARObject class for AUTOSAR models
+in the GenericStructure module.
+"""
+
+from abc import ABC
+from typing import Dict, Optional
+
+
+class ARObject(ABC):
+    """
+    Abstract base class for all AUTOSAR objects.
+    This class provides the basic structure and functionality for all AUTOSAR objects.
+    """
+
+    def __init__(self):
+        if type(self) is ARObject:
+            raise TypeError("ARObject is an abstract class.")
+
+        self.parent: Optional['ARObject'] = None
+        self.checksum: Optional[str] = None
+
+        self.timestamp: Optional[str] = None
+        self.uuid: Optional[str] = None
+
+    def getTagName(self, tag: str, nsmap: Dict) -> str:
+        """
+        Gets the tag name without namespace prefix.
+        
+        Args:
+            tag: The full tag name with namespace prefix
+            nsmap: The namespace map dictionary
+            
+        Returns:
+            The tag name without namespace prefix
+        """
+        return tag.replace("{%s}" % nsmap["xmlns"], "")

armodel/models/M2/AUTOSARTemplates/GenericStructure/GeneralTemplateClasses/ElementCollection.py

@@ -1,74 +1,197 @@
-from typing import List
-
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Identifier, NameToken, RefType
-from .....M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AnyInstanceRef
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-
-
-class Collection(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.autoCollect = None                                 # type: AutoCollectEnum
-        self.collectedInstances = []                            # type: List[AnyInstanceRef]
-        self.collectionSemantics = None                         # type: NameToken
-        self.elementRefs = []                                   # type: List[RefType]
-        self.elementRole = None                                 # type: Identifier
-        self.sourceElementRefs = []                             # type: List[RefType]
-        self.sourceInstances = []                               # type: List[AnyInstanceRef]
-
-    def getAutoCollect(self):
-        return self.autoCollect
-
-    def setAutoCollect(self, value):
-        if value is not None:
-            self.autoCollect = value
-        return self
-
-    def getCollectedInstances(self):
-        return self.collectedInstances
-
-    def setCollectedInstances(self, value):
-        if value is not None:
-            self.collectedInstances = value
-        return self
-
-    def getCollectionSemantics(self):
-        return self.collectionSemantics
-
-    def setCollectionSemantics(self, value):
-        if value is not None:
-            self.collectionSemantics = value
-        return self
-
-    def getElementRefs(self):
-        return self.elementRefs
-
-    def addElementRef(self, value):
-        if value is not None:
-            self.elementRefs.append(value)
-        return self
-
-    def getElementRole(self):
-        return self.elementRole
-
-    def setElementRole(self, value):
-        if value is not None:
-            self.elementRole = value
-        return self
-
-    def getSourceElementRefs(self):
-        return self.sourceElementRefs
-
-    def addSourceElementRef(self, value):
-        if value is not None:
-            self.sourceElementRefs.append(value)
-        return self
-
-    def getSourceInstances(self):
-        return self.sourceInstances
-
-    def setSourceInstances(self, value):
-        if value is not None:
-            self.sourceInstances = value
-        return self
+"""
+This module contains classes for representing AUTOSAR element collections
+in the GenericStructure module.
+"""
+
+from typing import List, Optional
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import Identifier, NameToken, RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.AnyInstanceRef import AnyInstanceRef
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Enumerations import AutoCollectEnum
+
+
+class Collection(ARElement):
+    """
+    Represents a collection of elements in AUTOSAR models.
+    This class defines the structure for organizing and managing collections of AUTOSAR elements.
+    """
+    
+    def __init__(self, parent, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.autoCollect: Optional[AutoCollectEnum] = None
+        self.collectedInstances: List[AnyInstanceRef] = []
+        self.collectionSemantics: Optional[NameToken] = None
+        self.elementRefs: List[RefType] = []
+        self.elementRole: Optional[Identifier] = None
+        self.sourceElementRefs: List[RefType] = []
+        self.sourceInstances: List[AnyInstanceRef] = []
+
+    def getAutoCollect(self) -> Optional[AutoCollectEnum]:
+        """
+        Gets the auto-collect setting for this collection.
+        
+        Returns:
+            AutoCollectEnum representing the auto-collect setting, or None if not set
+        """
+        return self.autoCollect
+
+    def setAutoCollect(self, value: AutoCollectEnum):
+        """
+        Sets the auto-collect setting for this collection.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The auto-collect setting to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.autoCollect = value
+        return self
+
+    def getCollectedInstances(self) -> List[AnyInstanceRef]:
+        """
+        Gets the list of collected instances in this collection.
+        
+        Returns:
+            List of AnyInstanceRef instances
+        """
+        return self.collectedInstances
+
+    def setCollectedInstances(self, value: List[AnyInstanceRef]):
+        """
+        Sets the list of collected instances in this collection.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The list of collected instances to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.collectedInstances = value
+        return self
+
+    def getCollectionSemantics(self) -> Optional[NameToken]:
+        """
+        Gets the collection semantics for this collection.
+        
+        Returns:
+            NameToken representing the collection semantics, or None if not set
+        """
+        return self.collectionSemantics
+
+    def setCollectionSemantics(self, value: NameToken):
+        """
+        Sets the collection semantics for this collection.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The collection semantics to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.collectionSemantics = value
+        return self
+
+    def getElementRefs(self) -> List[RefType]:
+        """
+        Gets the list of element references in this collection.
+        
+        Returns:
+            List of RefType instances representing element references
+        """
+        return self.elementRefs
+
+    def addElementRef(self, value: RefType):
+        """
+        Adds an element reference to this collection.
+        Only adds the value if it is not None.
+        
+        Args:
+            value: The element reference to add
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.elementRefs.append(value)
+        return self
+
+    def getElementRole(self) -> Optional[Identifier]:
+        """
+        Gets the element role for this collection.
+        
+        Returns:
+            Identifier representing the element role, or None if not set
+        """
+        return self.elementRole
+
+    def setElementRole(self, value: Identifier):
+        """
+        Sets the element role for this collection.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The element role to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.elementRole = value
+        return self
+
+    def getSourceElementRefs(self) -> List[RefType]:
+        """
+        Gets the list of source element references in this collection.
+        
+        Returns:
+            List of RefType instances representing source element references
+        """
+        return self.sourceElementRefs
+
+    def addSourceElementRef(self, value: RefType):
+        """
+        Adds a source element reference to this collection.
+        Only adds the value if it is not None.
+        
+        Args:
+            value: The source element reference to add
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.sourceElementRefs.append(value)
+        return self
+
+    def getSourceInstances(self) -> List[AnyInstanceRef]:
+        """
+        Gets the list of source instances in this collection.
+        
+        Returns:
+            List of AnyInstanceRef instances
+        """
+        return self.sourceInstances
+
+    def setSourceInstances(self, value: List[AnyInstanceRef]):
+        """
+        Sets the list of source instances in this collection.
+        Only sets the value if it is not None.
+        
+        Args:
+            value: The list of source instances to set
+            
+        Returns:
+            self for method chaining
+        """
+        if value is not None:
+            self.sourceInstances = value
+        return self

armodel/models/M2/AUTOSARTemplates/GenericStructure/GeneralTemplateClasses/EngineeringObject.py

@@ -1,52 +1,130 @@
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral
-from abc import ABCMeta
-
-class EngineeringObject(ARObject, metaclass=ABCMeta):
-    def __init__(self):
-        if type(self) == EngineeringObject:
-            raise NotImplementedError("EngineeringObject is an abstract class.")
-
-        super().__init__()
-
-        self.category = None                # type: ARLiteral
-        self.domain = None                  # type: ARLiteral
-        self.revision_label = None           # type: ARLiteral
-        self.short_label = None              # type: ARLiteral
-
-    def setCategory(self, category: any):
-        if isinstance(category, ARLiteral):
-            self.category = category
-        else:
-            self.category = ARLiteral()
-            self.category.setValue(str(category))
-        return self
-
-    def getCategory(self) -> ARLiteral:
-        return self.category
-
-    def setDomain(self, domain: ARLiteral):
-        self.domain = domain
-        return self
-
-    def getDomain(self) -> ARLiteral:
-        return self.domain
-
-    def setRevisionLabel(self, revision_label: ARLiteral):
-        self.revision_label = revision_label
-        return self
-
-    def getRevisionLabel(self) -> ARLiteral:
-        return self.revision_label
-
-    def setShortLabel(self, label: ARLiteral):
-        self.short_label = label
-        return self
-
-    def getShortLabel(self) -> ARLiteral:
-        return self.short_label
-
-
-class AutosarEngineeringObject(EngineeringObject):
-    def __init__(self):
+"""
+This module contains classes for representing AUTOSAR engineering objects
+in the GenericStructure module.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral
+from abc import ABC
+from typing import Optional, Any
+
+
+class EngineeringObject(ARObject, ABC):
+    """
+    Abstract class for AUTOSAR engineering objects.
+    This class defines the basic structure for engineering objects in AUTOSAR models.
+    """
+    
+    def __init__(self):
+        if type(self) == EngineeringObject:
+            raise TypeError("EngineeringObject is an abstract class.")
+
+        super().__init__()
+
+        self.category: Optional[ARLiteral] = None
+        self.domain: Optional[ARLiteral] = None
+        self.revision_label: Optional[ARLiteral] = None
+        self.short_label: Optional[ARLiteral] = None
+
+    def setCategory(self, category: Any):
+        """
+        Sets the category for this engineering object.
+        If the category is not an ARLiteral, it will be converted to one.
+        
+        Args:
+            category: The category to set
+            
+        Returns:
+            self for method chaining
+        """
+        if isinstance(category, ARLiteral):
+            self.category = category
+        else:
+            self.category = ARLiteral()
+            self.category.setValue(str(category))
+        return self
+
+    def getCategory(self) -> Optional[ARLiteral]:
+        """
+        Gets the category for this engineering object.
+        
+        Returns:
+            ARLiteral representing the category, or None if not set
+        """
+        return self.category
+
+    def setDomain(self, domain: ARLiteral):
+        """
+        Sets the domain for this engineering object.
+        
+        Args:
+            domain: The domain to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.domain = domain
+        return self
+
+    def getDomain(self) -> Optional[ARLiteral]:
+        """
+        Gets the domain for this engineering object.
+        
+        Returns:
+            ARLiteral representing the domain, or None if not set
+        """
+        return self.domain
+
+    def setRevisionLabel(self, revision_label: ARLiteral):
+        """
+        Sets the revision label for this engineering object.
+        
+        Args:
+            revision_label: The revision label to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.revision_label = revision_label
+        return self
+
+    def getRevisionLabel(self) -> Optional[ARLiteral]:
+        """
+        Gets the revision label for this engineering object.
+        
+        Returns:
+            ARLiteral representing the revision label, or None if not set
+        """
+        return self.revision_label
+
+    def setShortLabel(self, label: ARLiteral):
+        """
+        Sets the short label for this engineering object.
+        
+        Args:
+            label: The short label to set
+            
+        Returns:
+            self for method chaining
+        """
+        self.short_label = label
+        return self
+
+    def getShortLabel(self) -> Optional[ARLiteral]:
+        """
+        Gets the short label for this engineering object.
+        
+        Returns:
+            ARLiteral representing the short label, or None if not set
+        """
+        return self.short_label
+
+
+class AutosarEngineeringObject(EngineeringObject):
+    """
+    Represents an AUTOSAR engineering object.
+    This class extends EngineeringObject with AUTOSAR-specific functionality.
+    """
+    
+    def __init__(self):
         super().__init__()

armodel/models/M2/AUTOSARTemplates/GenericStructure/GeneralTemplateClasses/Enumerations.py

@@ -0,0 +1,16 @@
+"""
+This module contains enumeration classes for AUTOSAR models
+in the GenericStructure module. These enumerations are used to specify
+various configuration and behavior options throughout the AUTOSAR model.
+"""
+
+from enum import Enum
+
+class AutoCollectEnum(Enum):
+    """
+    Enumeration for auto-collect settings in AUTOSAR collections.
+    This enum defines the different auto-collection behaviors that can be applied to collections.
+    """
+    AUTO_COLLECT_OFF = "OFF"
+    AUTO_COLLECT_ON = "ON"
+    AUTO_COLLECT_AUTO = "AUTO"