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

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/Datatype/DataPrototypes.py

@@ -1,145 +1,145 @@
-from abc import ABCMeta
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARNumerical, PositiveInteger, TRefType
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
-from .....M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
-from .....M2.AUTOSARTemplates.CommonStructure import ValueSpecification
-from .....M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpFeature
-
-class AtpPrototype(AtpFeature, metaclass = ABCMeta):
-    def __init__(self, parent:ARObject, short_name: str):
-        if type(self) == AtpPrototype:
-            raise NotImplementedError("AtpPrototype is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-class DataPrototype(AtpPrototype, metaclass = ABCMeta):
-    def __init__(self, parent:ARObject, short_name: str):
-        if type(self) == DataPrototype:
-            raise NotImplementedError("DataPrototype is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.swDataDefProps = None          # type: SwDataDefProps
-
-    def getSwDataDefProps(self):
-        return self.swDataDefProps
-
-    def setSwDataDefProps(self, value):
-        self.swDataDefProps = value
-        return self
-    
-class AutosarDataPrototype(DataPrototype, metaclass = ABCMeta):
-    def __init__(self, parent:ARObject, short_name: str):
-        if type(self) == AutosarDataPrototype:
-            raise NotImplementedError("AutosarDataPrototype is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.typeTRef = None                # type:     TRefType
-
-    def getTypeTRef(self):
-        return self.typeTRef
-
-    def setTypeTRef(self, value):
-        self.typeTRef = value
-        return self
-
-class VariableDataPrototype(AutosarDataPrototype):
-    def __init__(self, parent:ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.initValue = None      # type: ValueSpecification
-
-    def getInitValue(self):
-        return self.initValue
-
-    def setInitValue(self, value):
-        self.initValue = value
-        return self
-
-class ApplicationCompositeElementDataPrototype(DataPrototype, metaclass = ABCMeta):
-    def __init__(self, parent:ARObject, short_name: str):
-        if type(self) == ApplicationCompositeElementDataPrototype:
-            raise NotImplementedError("ApplicationCompositeElementDataPrototype is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.typeTRef = None                    # type: RefType
-
-    def getTypeTRef(self):
-        return self.typeTRef
-
-    def setTypeTRef(self, value):
-        self.typeTRef = value
-        return self
-
-
-class ApplicationArrayElement(ApplicationCompositeElementDataPrototype):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.arraySizeHandling = None               # type: ArraySizeHandlingEnum
-        self.arraySizeSemantics = None              # type: ArraySizeSemanticsEnum
-        self.indexDataTypeRef = None                # type: RefType
-        self.maxNumberOfElements = None             # type: PositiveInteger
-
-    def getArraySizeHandling(self):
-        return self.arraySizeHandling
-
-    def setArraySizeHandling(self, value):
-        if value is not None:
-            self.arraySizeHandling = value
-        return self
-
-    def getArraySizeSemantics(self):
-        return self.arraySizeSemantics
-
-    def setArraySizeSemantics(self, value):
-        if value is not None:
-            self.arraySizeSemantics = value
-        return self
-
-    def getIndexDataTypeRef(self):
-        return self.indexDataTypeRef
-
-    def setIndexDataTypeRef(self, value):
-        if value is not None:
-            self.indexDataTypeRef = value
-        return self
-
-    def getMaxNumberOfElements(self):
-        return self.maxNumberOfElements
-
-    def setMaxNumberOfElements(self, value):
-        if value is not None:
-            self.maxNumberOfElements = value
-        return self
-    
-class ApplicationRecordElement(ApplicationCompositeElementDataPrototype):
-    def __init__(self, parent:ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.isOptional = None                                              # type: Boolean
-
-    def getIsOptional(self):
-        return self.isOptional
-
-    def setIsOptional(self, value):
-        if value is not None:
-            self.isOptional = value
-        return self
-
-
-class ParameterDataPrototype(AutosarDataPrototype):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.initValue = None                       # type: ValueSpecification
-
-    def getInitValue(self):
-        return self.initValue
-
-    def setInitValue(self, value):
-        self.initValue = value
-        return self
+"""
+This module contains classes for representing AUTOSAR data prototypes
+in the SWComponentTemplate module. It includes various types of data
+prototypes such as variable, parameter, and composite element prototypes
+used in software components.
+"""
+
+from abc import ABC
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import PositiveInteger, TRefType
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType
+from armodel.models.M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
+from armodel.models.M2.AUTOSARTemplates.CommonStructure import ValueSpecification
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpPrototype
+
+class DataPrototype(AtpPrototype, ABC):
+    def __init__(self, parent:ARObject, short_name: str):
+        if type(self) == DataPrototype:
+            raise TypeError("DataPrototype is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.swDataDefProps: SwDataDefProps = None
+
+    def getSwDataDefProps(self):
+        return self.swDataDefProps
+
+    def setSwDataDefProps(self, value):
+        self.swDataDefProps = value
+        return self
+    
+class AutosarDataPrototype(DataPrototype, ABC):
+    def __init__(self, parent:ARObject, short_name: str):
+        if type(self) == AutosarDataPrototype:
+            raise TypeError("AutosarDataPrototype is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.typeTRef: TRefType = None
+
+    def getTypeTRef(self):
+        return self.typeTRef
+
+    def setTypeTRef(self, value):
+        self.typeTRef = value
+        return self
+
+class VariableDataPrototype(AutosarDataPrototype):
+    def __init__(self, parent:ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.initValue: ValueSpecification = None
+
+    def getInitValue(self):
+        return self.initValue
+
+    def setInitValue(self, value):
+        self.initValue = value
+        return self
+
+class ApplicationCompositeElementDataPrototype(DataPrototype, ABC):
+    def __init__(self, parent:ARObject, short_name: str):
+        if type(self) == ApplicationCompositeElementDataPrototype:
+            raise TypeError("ApplicationCompositeElementDataPrototype is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.typeTRef: RefType = None
+
+    def getTypeTRef(self):
+        return self.typeTRef
+
+    def setTypeTRef(self, value):
+        self.typeTRef = value
+        return self
+
+
+class ApplicationArrayElement(ApplicationCompositeElementDataPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.arraySizeHandling = None
+        self.arraySizeSemantics = None
+        self.indexDataTypeRef: RefType = None
+        self.maxNumberOfElements: PositiveInteger = None
+
+    def getArraySizeHandling(self):
+        return self.arraySizeHandling
+
+    def setArraySizeHandling(self, value):
+        if value is not None:
+            self.arraySizeHandling = value
+        return self
+
+    def getArraySizeSemantics(self):
+        return self.arraySizeSemantics
+
+    def setArraySizeSemantics(self, value):
+        if value is not None:
+            self.arraySizeSemantics = value
+        return self
+
+    def getIndexDataTypeRef(self):
+        return self.indexDataTypeRef
+
+    def setIndexDataTypeRef(self, value):
+        if value is not None:
+            self.indexDataTypeRef = value
+        return self
+
+    def getMaxNumberOfElements(self):
+        return self.maxNumberOfElements
+
+    def setMaxNumberOfElements(self, value):
+        if value is not None:
+            self.maxNumberOfElements = value
+        return self
+    
+class ApplicationRecordElement(ApplicationCompositeElementDataPrototype):
+    def __init__(self, parent:ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.isOptional = None
+
+    def getIsOptional(self):
+        return self.isOptional
+
+    def setIsOptional(self, value):
+        if value is not None:
+            self.isOptional = value
+        return self
+
+
+class ParameterDataPrototype(AutosarDataPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.initValue: ValueSpecification = None
+
+    def getInitValue(self):
+        return self.initValue
+
+    def setInitValue(self, value):
+        self.initValue = value
+        return self

armodel/models/M2/AUTOSARTemplates/SWComponentTemplate/Datatype/Datatypes.py

@@ -1,131 +1,137 @@
-from typing import List
-from .....M2.AUTOSARTemplates.CommonStructure.ModeDeclaration import ModeRequestTypeMap
-from .....M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpType
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-from .....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARLiteral, RefType, String
-from .....M2.AUTOSARTemplates.SWComponentTemplate.Datatype.DataPrototypes import ApplicationArrayElement, ApplicationRecordElement
-from .....M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
-from abc import ABCMeta
-
-
-class AutosarDataType(AtpType, metaclass=ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) is AutosarDataType:
-            raise TypeError("AutosarDataType is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.swDataDefProps = None                  # type: SwDataDefProps
-
-    def getSwDataDefProps(self):
-        return self.swDataDefProps
-
-    def setSwDataDefProps(self, value):
-        self.swDataDefProps = value
-        return self
-
-
-class ApplicationDataType(AutosarDataType, metaclass=ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) is ApplicationDataType:
-            raise TypeError("ApplicationDataType is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-
-class ApplicationPrimitiveDataType(ApplicationDataType):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-
-class ApplicationCompositeDataType(ApplicationDataType, metaclass=ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) is ApplicationCompositeDataType:
-            raise TypeError("ApplicationCompositeDataType is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-
-class ApplicationArrayDataType(ApplicationCompositeDataType):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.dynamicArraySizeProfile = None         # type: String
-        self.element = None                         # type: ApplicationArrayElement
-
-    def getDynamicArraySizeProfile(self):
-        return self.dynamicArraySizeProfile
-
-    def setDynamicArraySizeProfile(self, value):
-        if value is not None:
-            self.dynamicArraySizeProfile = value
-        return self
-
-    def createApplicationArrayElement(self, short_name: str) -> ApplicationArrayElement:
-        if not self.IsElementExists(short_name):
-            array_element = ApplicationArrayElement(self, short_name)
-            self.addElement(array_element)
-            self.element = array_element
-        return self.getElement(short_name, ApplicationArrayElement)
-
-
-class ApplicationRecordDataType(ApplicationCompositeDataType):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.record_elements: List[ApplicationRecordElement] = []
-
-    def createApplicationRecordElement(self, short_name: str) -> ApplicationRecordElement:
-        if (not self.IsElementExists(short_name)):
-            record_element = ApplicationRecordElement(self, short_name)
-            self.addElement(record_element)
-            self.record_elements.append(record_element)
-        return self.getElement(short_name, ApplicationRecordElement)
-
-    def getApplicationRecordElements(self) -> List[ApplicationRecordElement]:
-        return self.record_elements
-
-
-class DataTypeMap(ARObject):
-    def __init__(self):
-
-        self.applicationDataTypeRef = None                  # type: RefType
-        self.implementationDataTypeRef = None               # type: RefType
-
-    def getApplicationDataTypeRef(self):
-        return self.applicationDataTypeRef
-
-    def setApplicationDataTypeRef(self, value):
-        self.applicationDataTypeRef = value
-        return self
-
-    def getImplementationDataTypeRef(self):
-        return self.implementationDataTypeRef
-
-    def setImplementationDataTypeRef(self, value):
-        self.implementationDataTypeRef = value
-        return self
-
-
-class DataTypeMappingSet(ARElement):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
-
-        self.dataTypeMaps = []                              # type: List[DataTypeMap]
-        # type: List[ModeRequestTypeMap]
-        self.modeRequestTypeMaps = []
-
-    def addDataTypeMap(self, type_map: DataTypeMap):
-        self.dataTypeMaps.append(type_map)
-        return self
-
-    def getDataTypeMaps(self) -> List[DataTypeMap]:
-        return self.dataTypeMaps
-
-    def addModeRequestTypeMap(self, map: ModeRequestTypeMap):
-        self.modeRequestTypeMaps.append(map)
-        return self
-
-    def getModeRequestTypeMaps(self) -> List[ModeRequestTypeMap]:
-        return self.modeRequestTypeMaps
+"""
+This module contains classes for representing AUTOSAR data types
+in the SWComponentTemplate module. It includes application and
+implementation data types, as well as datatype mapping classes
+used to map between different type representations.
+"""
+
+from typing import List
+from armodel.models.M2.AUTOSARTemplates.CommonStructure.ModeDeclaration import ModeRequestTypeMap
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.AbstractStructure import AtpType, AtpBlueprintable
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import RefType, String
+from armodel.models.M2.AUTOSARTemplates.SWComponentTemplate.Datatype.DataPrototypes import ApplicationArrayElement, ApplicationRecordElement
+from armodel.models.M2.MSR.DataDictionary.DataDefProperties import SwDataDefProps
+from abc import ABC
+
+
+class AutosarDataType(AtpType, ABC):
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is AutosarDataType:
+            raise TypeError("AutosarDataType is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.swDataDefProps: SwDataDefProps = None
+
+    def getSwDataDefProps(self):
+        return self.swDataDefProps
+
+    def setSwDataDefProps(self, value):
+        self.swDataDefProps = value
+        return self
+
+
+class ApplicationDataType(AutosarDataType, ABC):
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is ApplicationDataType:
+            raise TypeError("ApplicationDataType is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+
+class ApplicationPrimitiveDataType(ApplicationDataType):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+
+class ApplicationCompositeDataType(ApplicationDataType, ABC):
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) is ApplicationCompositeDataType:
+            raise TypeError("ApplicationCompositeDataType is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+
+class ApplicationArrayDataType(ApplicationCompositeDataType):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.dynamicArraySizeProfile: String = None
+        self.element: ApplicationArrayElement = None
+
+    def getDynamicArraySizeProfile(self):
+        return self.dynamicArraySizeProfile
+
+    def setDynamicArraySizeProfile(self, value):
+        if value is not None:
+            self.dynamicArraySizeProfile = value
+        return self
+
+    def createApplicationArrayElement(self, short_name: str) -> ApplicationArrayElement:
+        if not self.IsElementExists(short_name):
+            array_element = ApplicationArrayElement(self, short_name)
+            self.addElement(array_element)
+            self.element = array_element
+        return self.getElement(short_name, ApplicationArrayElement)
+
+
+class ApplicationRecordDataType(ApplicationCompositeDataType):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.record_elements: List[ApplicationRecordElement] = []
+
+    def createApplicationRecordElement(self, short_name: str) -> ApplicationRecordElement:
+        if (not self.IsElementExists(short_name)):
+            record_element = ApplicationRecordElement(self, short_name)
+            self.addElement(record_element)
+            self.record_elements.append(record_element)
+        return self.getElement(short_name, ApplicationRecordElement)
+
+    def getApplicationRecordElements(self) -> List[ApplicationRecordElement]:
+        return self.record_elements
+
+
+class DataTypeMap(ARObject):
+    def __init__(self):
+
+        self.applicationDataTypeRef: RefType = None
+        self.implementationDataTypeRef: RefType = None
+
+    def getApplicationDataTypeRef(self):
+        return self.applicationDataTypeRef
+
+    def setApplicationDataTypeRef(self, value):
+        self.applicationDataTypeRef = value
+        return self
+
+    def getImplementationDataTypeRef(self):
+        return self.implementationDataTypeRef
+
+    def setImplementationDataTypeRef(self, value):
+        self.implementationDataTypeRef = value
+        return self
+
+
+class DataTypeMappingSet(AtpBlueprintable):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.dataTypeMaps: List[DataTypeMap] = []
+        self.modeRequestTypeMaps: List[ModeRequestTypeMap] = []
+
+    def addDataTypeMap(self, type_map: DataTypeMap):
+        self.dataTypeMaps.append(type_map)
+        return self
+
+    def getDataTypeMaps(self) -> List[DataTypeMap]:
+        return self.dataTypeMaps
+
+    def addModeRequestTypeMap(self, map: ModeRequestTypeMap):
+        self.modeRequestTypeMaps.append(map)
+        return self
+
+    def getModeRequestTypeMaps(self) -> List[ModeRequestTypeMap]:
+        return self.modeRequestTypeMaps