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

armodel/models/M2/AUTOSARTemplates/CommonStructure/SignalServiceTranslation/SignalServiceTranslationControlEnum.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class SignalServiceTranslationControlEnum(Enum):
+    """
+    Enumeration for signal service translation control types in AUTOSAR.
+    Defines different control modes for signal service translation.
+    """
+
+    ENUM_AUTOMATIC = "automatic"
+    ENUM_MANUAL = "manual"

armodel/models/M2/AUTOSARTemplates/CommonStructure/SignalServiceTranslation/SignalServiceTranslationElementProps.py

@@ -0,0 +1,37 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+
+class SignalServiceTranslationElementProps(ARObject):
+    """
+    Represents signal service translation element properties in AUTOSAR.
+    Defines properties for signal service translation elements.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SignalServiceTranslationElementProps with default values.
+        """
+        super().__init__()
+        self.elementRef: str = None
+
+    def getElementRef(self) -> str:
+        """
+        Gets the element reference.
+
+        Returns:
+            String representing the element reference
+        """
+        return self.elementRef
+
+    def setElementRef(self, value: str):
+        """
+        Sets the element reference.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.elementRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/SignalServiceTranslation/SignalServiceTranslationEventProps.py

@@ -0,0 +1,37 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+
+class SignalServiceTranslationEventProps(ARObject):
+    """
+    Represents signal service translation event properties in AUTOSAR.
+    Defines properties for signal service translation events.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SignalServiceTranslationEventProps with default values.
+        """
+        super().__init__()
+        self.eventRef: str = None
+
+    def getEventRef(self) -> str:
+        """
+        Gets the event reference.
+
+        Returns:
+            String representing the event reference
+        """
+        return self.eventRef
+
+    def setEventRef(self, value: str):
+        """
+        Sets the event reference.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.eventRef = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/SignalServiceTranslation/SignalServiceTranslationProps.py

@@ -0,0 +1,38 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationControlEnum import SignalServiceTranslationControlEnum
+
+
+class SignalServiceTranslationProps(ARObject):
+    """
+    Represents signal service translation properties in AUTOSAR.
+    Defines properties for signal service translation.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SignalServiceTranslationProps with default values.
+        """
+        super().__init__()
+        self.translationControl: SignalServiceTranslationControlEnum = None
+
+    def getTranslationControl(self) -> SignalServiceTranslationControlEnum:
+        """
+        Gets the translation control type.
+
+        Returns:
+            Signal service translation control enum value
+        """
+        return self.translationControl
+
+    def setTranslationControl(self, value: SignalServiceTranslationControlEnum):
+        """
+        Sets the translation control type.
+
+        Args:
+            value: Signal service translation control enum value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.translationControl = value
+        return self

armodel/models/M2/AUTOSARTemplates/CommonStructure/SignalServiceTranslation/SignalServiceTranslationPropsSet.py

@@ -0,0 +1,38 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from typing import List
+
+
+class SignalServiceTranslationPropsSet(ARObject):
+    """
+    Represents a set of signal service translation properties in AUTOSAR.
+    Defines a collection of signal service translation property sets.
+    """
+
+    def __init__(self):
+        """
+        Initializes the SignalServiceTranslationPropsSet with default values.
+        """
+        super().__init__()
+        self.translationProps: List[str] = []
+
+    def addTranslationProp(self, prop: str):
+        """
+        Adds a translation property to this set.
+
+        Args:
+            prop: The translation property to add
+
+        Returns:
+            self for method chaining
+        """
+        self.translationProps.append(prop)
+        return self
+
+    def getTranslationProps(self) -> List[str]:
+        """
+        Gets the list of translation properties.
+
+        Returns:
+            List of translation properties
+        """
+        return self.translationProps

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

@@ -0,0 +1,13 @@
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationControlEnum import SignalServiceTranslationControlEnum
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationElementProps import SignalServiceTranslationElementProps
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationEventProps import SignalServiceTranslationEventProps
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationProps import SignalServiceTranslationProps
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.SignalServiceTranslationPropsSet import SignalServiceTranslationPropsSet
+
+__all__ = [
+    'SignalServiceTranslationControlEnum',
+    'SignalServiceTranslationElementProps',
+    'SignalServiceTranslationEventProps',
+    'SignalServiceTranslationProps',
+    'SignalServiceTranslationPropsSet'
+]

armodel/models/M2/AUTOSARTemplates/CommonStructure/StandardizationTemplate/AbstractBlueprintStructure/AtpBlueprint.py

@@ -0,0 +1,32 @@
+"""
+This module contains the AtpBlueprint abstract class for AUTOSAR models
+in the CommonStructure module.
+"""
+
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import Identifiable
+
+
+class AtpBlueprint(Identifiable, ABC):
+    """
+    Abstract base class for AUTOSAR Template (ATP) blueprint elements.
+    
+    AtpBlueprint represents blueprint elements in the AUTOSAR system. Blueprints
+    provide reusable definitions that can be used as templates for creating
+    specific instances or mappings in AUTOSAR models.
+    
+    This class extends Identifiable with blueprint-specific functionality for
+    managing template-based elements.
+    
+    Note:
+        This is an abstract class and cannot be instantiated directly.
+        Concrete implementations include ClientServerInterfaceToBswModuleEntryBlueprintMapping.
+    
+    Attributes:
+        Inherits all attributes from Identifiable including shortName and adminData.
+    """
+    
+    def __init__(self, parent, short_name: str):
+        if type(self) is AtpBlueprint:
+            raise TypeError("AtpBlueprint is an abstract class.")
+        super().__init__(parent, short_name)

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

@@ -0,0 +1,7 @@
+"""
+AbstractBlueprintStructure module for AUTOSAR M2 models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.StandardizationTemplate.AbstractBlueprintStructure.AtpBlueprint import AtpBlueprint
+
+__all__ = ['AtpBlueprint']

armodel/models/M2/AUTOSARTemplates/CommonStructure/StandardizationTemplate/BlueprintDedicated/PortPrototypeBlueprint.py

@@ -1,73 +1,186 @@
-from typing import List
-
-from ......M2.AUTOSARTemplates.CommonStructure import ValueSpecification
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from ......M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-from ......M2.AUTOSARTemplates.SWComponentTemplate.Communication import PPortComSpec
-
-
-class PortPrototypeBlueprintInitValue(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.dataPrototypeRef = None                            # type: RefType
-        self.value = None                                       # type: ValueSpecification
-
-    def getDataPrototypeRef(self):
-        return self.dataPrototypeRef
-
-    def setDataPrototypeRef(self, value):
-        if value is not None:
-            self.dataPrototypeRef = value
-        return self
-
-    def getValue(self):
-        return self.value
-
-    def setValue(self, value):
-        if value is not None:
-            self.value = value
-        return self
-
-
-class PortPrototypeBlueprint(ARElement):
-    def __init__(self, parent, short_name):
-        super().__init__(parent, short_name)
-
-        self.initValues = []                                    # type: List[PortPrototypeBlueprintInitValue]
-        self.interfaceRef = None                                # type: RefType
-        self.providedComSpecs = []                              # type: List[PPortComSpec]
-        self.requiredComSpecs = []                              # type: List[RPortComSpec]
-
-    def getInitValues(self):
-        return self.initValues
-
-    def setInitValues(self, value):
-        if value is not None:
-            self.initValues = value
-        return self
-
-    def getInterfaceRef(self):
-        return self.interfaceRef
-
-    def setInterfaceRef(self, value):
-        if value is not None:
-            self.interfaceRef = value
-        return self
-
-    def getProvidedComSpecs(self):
-        return self.providedComSpecs
-
-    def setProvidedComSpecs(self, value):
-        if value is not None:
-            self.providedComSpecs = value
-        return self
-
-    def getRequiredComSpecs(self):
-        return self.requiredComSpecs
-
-    def setRequiredComSpecs(self, value):
-        if value is not None:
-            self.requiredComSpecs = value
-        return self
+"""
+This module defines classes for port prototype blueprints in AUTOSAR standardization templates.
+
+Port prototype blueprints provide a way to define standard templates for port prototypes
+that can be reused across different AUTOSAR software components. This is particularly useful
+for standardization and blueprint-based development approaches in AUTOSAR architecture.
+
+Classes:
+    PortPrototypeBlueprintInitValue: Represents initial value specifications for port prototype blueprints
+    PortPrototypeBlueprint: Defines a blueprint for port prototypes with communication specifications
+"""
+
+from typing import List
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure import ValueSpecification
+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.PrimitiveTypes import RefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
+from armodel.models.M2.AUTOSARTemplates.SWComponentTemplate.Communication import PPortComSpec, RPortComSpec
+
+
+class PortPrototypeBlueprintInitValue(ARObject):
+    """
+    Represents an initial value specification for a port prototype blueprint.
+    This class defines the initial value and associated data prototype reference
+    for a specific port prototype blueprint element.
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.dataPrototypeRef: RefType = None
+        self.value: ValueSpecification = None
+
+    def getDataPrototypeRef(self) -> RefType:
+        """
+        Gets the data prototype reference for this initial value specification.
+        
+        Returns:
+            Reference to the data prototype
+        """
+        return self.dataPrototypeRef
+
+    def setDataPrototypeRef(self, value: RefType):
+        """
+        Sets the data prototype reference for this initial value specification.
+        
+        Args:
+            value: Reference to the data prototype
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.dataPrototypeRef = value
+        return self
+
+    def getValue(self) -> ValueSpecification:
+        """
+        Gets the value specification for this initial value.
+        
+        Returns:
+            The value specification
+        """
+        return self.value
+
+    def setValue(self, value: ValueSpecification):
+        """
+        Sets the value specification for this initial value.
+        
+        Args:
+            value: The value specification
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.value = value
+        return self
+
+
+class PortPrototypeBlueprint(AtpStructureElement):
+    """
+    Defines a blueprint for port prototypes in AUTOSAR standardization templates.
+    This class provides a template for defining port prototypes that can be reused
+    across different software components, helping to standardize port configurations.
+    """
+    def __init__(self, parent, short_name):
+        super().__init__(parent, short_name)
+
+        self.initValues: List[PortPrototypeBlueprintInitValue] = []
+        self.interfaceRef: RefType = None
+        self.providedComSpecs: List[PPortComSpec] = []
+        self.requiredComSpecs: List[RPortComSpec] = []
+
+    def getInitValues(self) -> List[PortPrototypeBlueprintInitValue]:
+        """
+        Gets the list of initial value specifications for this port prototype blueprint.
+        
+        Returns:
+            List of initial value specifications
+        """
+        return self.initValues
+
+    def setInitValues(self, value: List[PortPrototypeBlueprintInitValue]):
+        """
+        Sets the list of initial value specifications for this port prototype blueprint.
+        
+        Args:
+            value: List of initial value specifications
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.initValues = value
+        return self
+
+    def getInterfaceRef(self) -> RefType:
+        """
+        Gets the interface reference for this port prototype blueprint.
+        
+        Returns:
+            Reference to the interface
+        """
+        return self.interfaceRef
+
+    def setInterfaceRef(self, value: RefType):
+        """
+        Sets the interface reference for this port prototype blueprint.
+        
+        Args:
+            value: Reference to the interface
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.interfaceRef = value
+        return self
+
+    def getProvidedComSpecs(self) -> List[PPortComSpec]:
+        """
+        Gets the list of provided communication specifications for this port prototype blueprint.
+        
+        Returns:
+            List of provided communication specifications
+        """
+        return self.providedComSpecs
+
+    def setProvidedComSpecs(self, value: List[PPortComSpec]):
+        """
+        Sets the list of provided communication specifications for this port prototype blueprint.
+        
+        Args:
+            value: List of provided communication specifications
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.providedComSpecs = value
+        return self
+
+    def getRequiredComSpecs(self) -> List[RPortComSpec]:
+        """
+        Gets the list of required communication specifications for this port prototype blueprint.
+        
+        Returns:
+            List of required communication specifications
+        """
+        return self.requiredComSpecs
+
+    def setRequiredComSpecs(self, value: List[RPortComSpec]):
+        """
+        Sets the list of required communication specifications for this port prototype blueprint.
+        
+        Args:
+            value: List of required communication specifications
+            
+        Returns:
+            Self instance for method chaining
+        """
+        if value is not None:
+            self.requiredComSpecs = value
+        return self

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

@@ -0,0 +1,10 @@
+"""
+This module contains blueprint-dedicated standardization template classes for AUTOSAR models.
+"""
+
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.StandardizationTemplate.BlueprintDedicated.PortPrototypeBlueprint import PortPrototypeBlueprintInitValue, PortPrototypeBlueprint
+
+__all__ = [
+    'PortPrototypeBlueprintInitValue', 
+    'PortPrototypeBlueprint'
+]

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

@@ -0,0 +1,37 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+
+
+class BlueprintGenerator(ARObject):
+    """
+    Represents a blueprint generator in AUTOSAR.
+    Defines a generator for creating blueprints from templates.
+    """
+
+    def __init__(self):
+        """
+        Initializes the BlueprintGenerator with default values.
+        """
+        super().__init__()
+        self.generatorName: str = None
+
+    def getGeneratorName(self) -> str:
+        """
+        Gets the generator name.
+
+        Returns:
+            String representing the generator name
+        """
+        return self.generatorName
+
+    def setGeneratorName(self, value: str):
+        """
+        Sets the generator name.
+
+        Args:
+            value: String value to set
+
+        Returns:
+            self for method chaining
+        """
+        self.generatorName = value
+        return self

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

@@ -0,0 +1,3 @@
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.StandardizationTemplate.BlueprintGenerator import BlueprintGenerator
+
+__all__ = ['BlueprintGenerator']

armodel/models/M2/AUTOSARTemplates/CommonStructure/StandardizationTemplate/BlueprintMapping/BlueprintMappingSet.py

@@ -0,0 +1,38 @@
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from typing import List
+
+
+class BlueprintMappingSet(ARObject):
+    """
+    Represents a set of blueprint mappings in AUTOSAR.
+    Defines a collection of blueprint mappings.
+    """
+
+    def __init__(self):
+        """
+        Initializes the BlueprintMappingSet with default values.
+        """
+        super().__init__()
+        self.mappings: List[str] = []
+
+    def addMapping(self, mapping: str):
+        """
+        Adds a mapping to this set.
+
+        Args:
+            mapping: The mapping to add
+
+        Returns:
+            self for method chaining
+        """
+        self.mappings.append(mapping)
+        return self
+
+    def getMappings(self) -> List[str]:
+        """
+        Gets the list of mappings.
+
+        Returns:
+            List of mappings
+        """
+        return self.mappings

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

@@ -0,0 +1,3 @@
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.StandardizationTemplate.BlueprintMappingSet import BlueprintMappingSet
+
+__all__ = ['BlueprintMappingSet']