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

armodel/models/M2/MSR/AsamHdo/AdminData.py

@@ -1,136 +1,150 @@
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import DateTime, NameToken, RevisionLabelString, String
-from ....M2.MSR.Documentation.TextModel.LanguageDataModel import LEnum
-from ....M2.MSR.Documentation.TextModel.MultilanguageData import MultiLanguageOverviewParagraph, MultiLanguagePlainText
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from typing import List
-
-
-class Modification(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.change: MultiLanguageOverviewParagraph = None
-        self.reason: MultiLanguageOverviewParagraph = None
-
-    def getChange(self) -> MultiLanguageOverviewParagraph:
-        return self.change
-
-    def setChange(self, value: MultiLanguageOverviewParagraph):
-        if value is not None:
-            self.change = value
-        return self
-
-    def getReason(self) -> MultiLanguageOverviewParagraph:
-        return self.reason
-
-    def setReason(self, value: MultiLanguageOverviewParagraph):
-        if value is not None:
-            self.reason = value
-        return self
-
-
-class DocRevision(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.date: DateTime = None
-        self.issuedBy: String = None
-        self.modifications: List[Modification] = []
-        self.revisionLabel: RevisionLabelString = None
-        self.revisionLabelP1: RevisionLabelString = None
-        self.revisionLabelP2: RevisionLabelString = None
-        self.state: NameToken = None
-
-    def getDate(self) -> DateTime:
-        return self.date
-
-    def setDate(self, value: DateTime):
-        if value is not None:
-            self.date = value
-        return self
-
-    def getIssuedBy(self) -> String:
-        return self.issuedBy
-
-    def setIssuedBy(self, value: String):
-        if value is not None:
-            self.issuedBy = value
-        return self
-
-    def getModifications(self) -> List[Modification]:
-        return self.modifications
-
-    def addModification(self, value: List[Modification]):
-        if value is not None:
-            self.modifications.append(value)
-        return self
-
-    def getRevisionLabel(self) -> RevisionLabelString:
-        return self.revisionLabel
-
-    def setRevisionLabel(self, value: RevisionLabelString):
-        if value is not None:
-            self.revisionLabel = value
-        return self
-
-    def getRevisionLabelP1(self) -> RevisionLabelString:
-        return self.revisionLabelP1
-
-    def setRevisionLabelP1(self, value: RevisionLabelString):
-        if value is not None:
-            self.revisionLabelP1 = value
-        return self
-
-    def getRevisionLabelP2(self) -> RevisionLabelString:
-        return self.revisionLabelP2
-
-    def setRevisionLabelP2(self, value: RevisionLabelString):
-        if value is not None:
-            self.revisionLabelP2 = value
-        return self
-
-    def getState(self) -> NameToken:
-        return self.state
-
-    def setState(self, value: NameToken):
-        if value is not None:
-            self.state = value
-        return self
-
-
-class AdminData(ARObject):
-    def __init__(self):
-        super().__init__()
-
-        self.DocRevisions: List[DocRevision] = []
-        self.language: LEnum = None
-        self.sdgs: List = []
-        self.usedLanguages: MultiLanguagePlainText = None
-
-    def getDocRevisions(self):
-        return self.DocRevisions
-
-    def addDocRevision(self, value: DocRevision):
-        self.DocRevisions.append(value)
-        return self
-
-    def getLanguage(self):
-        return self.language
-
-    def setLanguage(self, value):
-        self.language = value
-        return self
-
-    def getSdgs(self):
-        return self.sdgs
-
-    def addSdg(self, value):
-        self.sdgs.append(value)
-        return self
-
-    def getUsedLanguages(self):
-        return self.usedLanguages
-
-    def setUsedLanguages(self, value):
-        self.usedLanguages = value
-        return self
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import DateTime, NameToken, RevisionLabelString, String
+from armodel.models.M2.MSR.Documentation.TextModel.LanguageDataModel import LEnum
+from armodel.models.M2.MSR.Documentation.TextModel.MultilanguageData import MultiLanguageOverviewParagraph, MultiLanguagePlainText
+from armodel.models.M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
+from typing import List
+
+
+class Modification(ARObject):
+    """
+    Represents a modification made to a document.
+    Base: ARObject
+    Aggregated by: DocRevision.modifications
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.change: MultiLanguageOverviewParagraph = None
+        self.reason: MultiLanguageOverviewParagraph = None
+
+    def getChange(self) -> MultiLanguageOverviewParagraph:
+        return self.change
+
+    def setChange(self, value: MultiLanguageOverviewParagraph):
+        if value is not None:
+            self.change = value
+        return self
+
+    def getReason(self) -> MultiLanguageOverviewParagraph:
+        return self.reason
+
+    def setReason(self, value: MultiLanguageOverviewParagraph):
+        if value is not None:
+            self.reason = value
+        return self
+
+
+class DocRevision(ARObject):
+    """
+    Represents a single revision of a document with metadata.
+    Base: ARObject
+    Aggregated by: AdminData.DocRevisions
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.date: DateTime = None
+        self.issuedBy: String = None
+        self.modifications: List[Modification] = []
+        self.revisionLabel: RevisionLabelString = None
+        self.revisionLabelP1: RevisionLabelString = None
+        self.revisionLabelP2: RevisionLabelString = None
+        self.state: NameToken = None
+
+    def getDate(self) -> DateTime:
+        return self.date
+
+    def setDate(self, value: DateTime):
+        if value is not None:
+            self.date = value
+        return self
+
+    def getIssuedBy(self) -> String:
+        return self.issuedBy
+
+    def setIssuedBy(self, value: String):
+        if value is not None:
+            self.issuedBy = value
+        return self
+
+    def getModifications(self) -> List[Modification]:
+        return self.modifications
+
+    def addModification(self, value: Modification):
+        if value is not None:
+            self.modifications.append(value)
+        return self
+
+    def getRevisionLabel(self) -> RevisionLabelString:
+        return self.revisionLabel
+
+    def setRevisionLabel(self, value: RevisionLabelString):
+        if value is not None:
+            self.revisionLabel = value
+        return self
+
+    def getRevisionLabelP1(self) -> RevisionLabelString:
+        return self.revisionLabelP1
+
+    def setRevisionLabelP1(self, value: RevisionLabelString):
+        if value is not None:
+            self.revisionLabelP1 = value
+        return self
+
+    def getRevisionLabelP2(self) -> RevisionLabelString:
+        return self.revisionLabelP2
+
+    def setRevisionLabelP2(self, value: RevisionLabelString):
+        if value is not None:
+            self.revisionLabelP2 = value
+        return self
+
+    def getState(self) -> NameToken:
+        return self.state
+
+    def setState(self, value: NameToken):
+        if value is not None:
+            self.state = value
+        return self
+
+
+class AdminData(ARObject):
+    """
+    Container for administrative data including document revisions and language settings.
+    Base: ARObject
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.DocRevisions: List[DocRevision] = []
+        self.language: LEnum = None
+        self.sdgs: List = []
+        self.usedLanguages: MultiLanguagePlainText = None
+
+    def getDocRevisions(self) -> List[DocRevision]:
+        return self.DocRevisions
+
+    def addDocRevision(self, value: DocRevision):
+        self.DocRevisions.append(value)
+        return self
+
+    def getLanguage(self):
+        return self.language
+
+    def setLanguage(self, value):
+        self.language = value
+        return self
+
+    def getSdgs(self):
+        return self.sdgs
+
+    def addSdg(self, value):
+        self.sdgs.append(value)
+        return self
+
+    def getUsedLanguages(self):
+        return self.usedLanguages
+
+    def setUsedLanguages(self, value):
+        self.usedLanguages = value
+        return self

armodel/models/M2/MSR/AsamHdo/BaseTypes.py

@@ -1,76 +1,95 @@
-from abc import ABCMeta
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.ArObject import ARObject
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.Identifiable import ARElement
-from ....M2.AUTOSARTemplates.GenericStructure.GeneralTemplateClasses.PrimitiveTypes import ARNumerical
-
-class BaseTypeDefinition(ARObject):
-    def __init__(self):
-        super().__init__()
-
-
-class BaseTypeDirectDefinition(BaseTypeDefinition):
-    def __init__(self):
-        super().__init__()
-
-        self.baseTypeEncoding = None                # type: BaseTypeEncodingString
-        self.baseTypeSize = None                    # type: ARNumerical
-        self.byteOrder = None                       # type: ByteOrderEnum
-        self.memAlignment = None                    # type: ARNumerical
-        self.nativeDeclaration = None
-
-    def getBaseTypeEncoding(self):
-        return self.baseTypeEncoding
-
-    def setBaseTypeEncoding(self, value):
-        self.baseTypeEncoding = value
-        return self
-
-    def getBaseTypeSize(self):
-        return self.baseTypeSize
-
-    def setBaseTypeSize(self, value):
-        self.baseTypeSize = value
-        return self
-
-    def getByteOrder(self):
-        return self.byteOrder
-
-    def setByteOrder(self, value):
-        self.byteOrder = value
-        return self
-
-    def getMemAlignment(self):
-        return self.memAlignment
-
-    def setMemAlignment(self, value):
-        self.memAlignment = value
-        return self
-
-    def getNativeDeclaration(self):
-        return self.nativeDeclaration
-
-    def setNativeDeclaration(self, value):
-        self.nativeDeclaration = value
-        return self
-
-
-
-class BaseType(ARElement, metaclass=ABCMeta):
-    def __init__(self, parent: ARObject, short_name: str):
-        if type(self) == BaseType:
-            raise NotImplementedError("BaseType is an abstract class.")
-
-        super().__init__(parent, short_name)
-
-        self.baseTypeDefinition = BaseTypeDirectDefinition()
-
-    def getBaseTypeDefinition(self):
-        return self.baseTypeDefinition
-
-    def setBaseTypeDefinition(self, value):
-        self.baseTypeDefinition = value
-        return self
-
-class SwBaseType(BaseType):
-    def __init__(self, parent: ARObject, short_name: str):
-        super().__init__(parent, short_name)
+from abc import ABC
+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 ARNumerical, ByteOrderEnum
+
+class BaseTypeDefinition(ARObject, ABC):
+    """
+    Abstract base class for base type definitions.
+    Base: ARObject
+    """
+
+    def __init__(self):
+        if type(self) is BaseTypeDefinition:
+            raise TypeError("BaseTypeDefinition is an abstract class.")
+        super().__init__()
+
+
+class BaseTypeDirectDefinition(BaseTypeDefinition):
+    """
+    Direct definition of a base type with encoding, size, and memory alignment specifications.
+    Base: BaseTypeDefinition
+    """
+    def __init__(self):
+        super().__init__()
+
+        self.baseTypeEncoding: str = None
+        self.baseTypeSize: ARNumerical = None
+        self.byteOrder: ByteOrderEnum = None
+        self.memAlignment: ARNumerical = None
+        self.nativeDeclaration: str = None
+
+    def getBaseTypeEncoding(self):
+        return self.baseTypeEncoding
+
+    def setBaseTypeEncoding(self, value):
+        self.baseTypeEncoding = value
+        return self
+
+    def getBaseTypeSize(self):
+        return self.baseTypeSize
+
+    def setBaseTypeSize(self, value):
+        self.baseTypeSize = value
+        return self
+
+    def getByteOrder(self):
+        return self.byteOrder
+
+    def setByteOrder(self, value):
+        self.byteOrder = value
+        return self
+
+    def getMemAlignment(self):
+        return self.memAlignment
+
+    def setMemAlignment(self, value):
+        self.memAlignment = value
+        return self
+
+    def getNativeDeclaration(self):
+        return self.nativeDeclaration
+
+    def setNativeDeclaration(self, value):
+        self.nativeDeclaration = value
+        return self
+
+
+
+class BaseType(ARElement, ABC):
+    """
+    Abstract base class for base types.
+    Base: ARElement
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        if type(self) == BaseType:
+            raise TypeError("BaseType is an abstract class.")
+
+        super().__init__(parent, short_name)
+
+        self.baseTypeDefinition: BaseTypeDirectDefinition = BaseTypeDirectDefinition()
+
+    def getBaseTypeDefinition(self) -> BaseTypeDirectDefinition:
+        return self.baseTypeDefinition
+
+    def setBaseTypeDefinition(self, value: BaseTypeDirectDefinition):
+        self.baseTypeDefinition = value
+        return self
+
+class SwBaseType(BaseType):
+    """
+    Software base type representing primitive data types in software.
+    Base: BaseType
+    """
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)