armodel 1.4.3__py3-none-any.whl → 1.6.0__py3-none-any.whl

armodel/models/m2/autosar_templates/ecuc_description_template.py

@@ -0,0 +1,268 @@
+from abc import ABCMeta
+from typing import List
+
+from ..msr.documentation.block_elements import DocumentationBlock
+from ...annotation import Annotation
+from ...ar_ref import AnyInstanceRef, RefType
+from ...ar_object import ARBoolean, ARLiteral, ARNumerical, ARObject
+from ...general_structure import ARElement
+
+class EcucValueCollection(ARElement):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.ecucValueRefs = []
+        self.ecuExtractRef = None
+
+    def getEcucValueRefs(self) -> List[RefType]:
+        return self.ecucValueRefs
+
+    def addEcucValueRef(self, ref: RefType):
+        self.ecucValueRefs.append(ref)
+        return self
+
+    def getEcuExtractRef(self):
+        return self.ecuExtractRef
+
+    def setEcuExtractRef(self, value):
+        self.ecuExtractRef = value
+        return self
+    
+class EcucIndexableValue(ARObject, metaclass = ABCMeta):
+    def __init__(self):
+        if type(self) == EcucIndexableValue:
+            raise NotImplementedError("EcucIndexableValue is an abstract class.")
+        
+        super().__init__()
+
+class EcucAbstractReferenceValue(EcucIndexableValue, metaclass=ABCMeta):
+    def __init__(self):
+        if type(self) == EcucAbstractReferenceValue:
+            raise NotImplementedError("EcucAbstractReferenceValue is an abstract class.")
+        
+        super().__init__()
+    
+class EcucParameterValue(EcucIndexableValue, metaclass=ABCMeta):
+    def __init__(self):
+        if type(self) == EcucParameterValue:
+            raise NotImplementedError("EcucParameterValue is an abstract class.")
+        
+        super().__init__()
+
+        self.annotations = []                       # type: List[Annotation]
+        self.definitionRef = None                   # type: RefType
+        self.isAutoValue = None                     # type: ARBoolean
+
+    def getAnnotations(self) -> List[Annotation]:
+        return self.annotations
+
+    def addAnnotation(self, value: Annotation):
+        self.annotations.append(value)
+        return self
+
+    def getDefinitionRef(self) -> RefType:
+        return self.definitionRef
+
+    def setDefinitionRef(self, value: RefType):
+        self.definitionRef = value
+        return self
+
+    def getIsAutoValue(self) -> ARBoolean:
+        return self.isAutoValue
+
+    def setIsAutoValue(self, value: ARBoolean):
+        self.isAutoValue = value
+        return self
+
+class EcucAddInfoParamValue(EcucParameterValue):
+    def __init__(self):
+        super().__init__()
+
+        self.value = None                           # type: DocumentationBlock
+
+    def getValue(self) -> DocumentationBlock:
+        return self.value
+
+    def setValue(self, value: DocumentationBlock):
+        self.value = value
+
+class EcucTextualParamValue(EcucParameterValue):
+    def __init__(self):
+        super().__init__()
+
+        self.value = None                           # type: ARLiteral
+
+    def getValue(self) -> ARLiteral:
+        return self.value
+
+    def setValue(self, value:ARLiteral):
+        self.value = value
+
+
+class EcucNumericalParamValue(EcucParameterValue):
+    def __init__(self):
+        super().__init__()
+
+        self.value = None                           # type: ARNumerical
+
+    def getValue(self) -> ARNumerical:
+        return self.value
+
+    def setValue(self, value: ARNumerical):
+        self.value = value
+
+class EcucAbstractReferenceValue(EcucIndexableValue, metaclass=ABCMeta):
+    def __init__(self):
+        if type(self) == EcucAbstractReferenceValue:
+            raise NotImplementedError("EcucAbstractReferenceValue is an abstract class.")
+        
+        super().__init__()
+
+        self.annotations = []                       # type: List[Annotation]
+        self.definitionRef = None                   # type: RefType
+        self.isAutoValue = None                     # type: ARBoolean
+
+    def getAnnotations(self) -> List[Annotation]:
+        return self.annotations
+
+    def addAnnotation(self, value: Annotation):
+        self.annotations.append(value)
+        return self
+
+    def getDefinitionRef(self) -> RefType:
+        return self.definitionRef
+
+    def setDefinitionRef(self, value: RefType):
+        self.definitionRef = value
+        return self
+
+    def getIsAutoValue(self) -> ARBoolean:
+        return self.isAutoValue
+
+    def setIsAutoValue(self, value: ARBoolean):
+        self.isAutoValue = value
+        return self
+
+class EcucInstanceReferenceValue(EcucAbstractReferenceValue):
+    def __init__(self):
+        super().__init__()
+
+        self.valueIRef = None        # type: AnyInstanceRef
+
+    def getValueIRef(self) -> AnyInstanceRef:
+        return self.valueRef
+
+    def setValueIRef(self, value: AnyInstanceRef):
+        self.valueRef = value
+        return self
+
+class EcucReferenceValue(EcucAbstractReferenceValue):
+    def __init__(self):
+        super().__init__()
+
+        self.valueRef = None        # type: RefType
+
+    def getValueRef(self) -> RefType:
+        return self.valueRef
+
+    def setValueRef(self, value: RefType):
+        self.valueRef = value
+        return self
+
+class EcucContainerValue(ARElement, EcucIndexableValue):
+    def __init__(self, parent: ARObject, short_name: str):
+        ARElement.__init__(self, parent, short_name)
+
+        self.definitionRef = None                   # type: RefType
+        self.parameterValues = []                   # type: List[EcucParameterValue]
+        self.referenceValues = []                   # type: List[EcucAbstractReferenceValue]
+        self.subContainers = []                     # type: List[EcucContainerValue]
+
+    def getDefinitionRef(self) -> RefType:
+        return self.definitionRef
+
+    def setDefinitionRef(self, value: RefType):
+        self.definitionRef = value
+        return self
+
+    def getParameterValues(self)-> List[EcucParameterValue]:
+        return self.parameterValues
+
+    def addParameterValue(self, value: EcucParameterValue):
+        self.parameterValues.append(value)
+        return self
+
+    def getReferenceValues(self) -> EcucAbstractReferenceValue:
+        return self.referenceValues
+
+    def addReferenceValue(self, value: EcucAbstractReferenceValue):
+        self.referenceValues.append(value)
+        return self
+
+    def getSubContainers(self):
+        return self.subContainers
+
+    def createSubContainer(self, short_name):
+        if (short_name not in self.elements):
+            container_value = EcucContainerValue(self, short_name)
+            self.elements[short_name] = container_value
+            self.subContainers.append(container_value)
+        return self.elements[short_name]
+
+
+class EcucModuleConfigurationValues(ARElement):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.containers = []                        # type: List[EcucContainerValue]
+        self.definitionRef = None                   # type: RefType
+        self.ecucDefEdition = None                  # type: ARLiteral
+        self.implementationConfigVariant = None     # type: ARLiteral
+        self.moduleDescriptionRef = None            # type: RefType
+        self.postBuildVariantUsed = None            # type: ARBoolean
+
+    def createContainer(self, short_name: str) -> EcucContainerValue:
+        if (short_name not in self.elements):
+            container = EcucContainerValue(self, short_name)
+            self.elements[short_name] = container
+            self.containers.append(container)
+        return self.elements[short_name]
+
+    def getContainers(self) -> List[EcucContainerValue]:
+        return list(sorted(filter(lambda a: isinstance(a, EcucContainerValue), self.elements.values()), key= lambda o:o.short_name))
+
+    def getDefinitionRef(self) -> RefType:
+        return self.definitionRef
+
+    def setDefinitionRef(self, value: RefType):
+        self.definitionRef = value
+        return self
+
+    def getEcucDefEdition(self) -> ARLiteral:
+        return self.ecucDefEdition
+
+    def setEcucDefEdition(self, value: ARLiteral):
+        self.ecucDefEdition = value
+        return self
+
+    def getImplementationConfigVariant(self) -> ARLiteral:
+        return self.implementationConfigVariant
+
+    def setImplementationConfigVariant(self, value: ARLiteral):
+        self.implementationConfigVariant = value
+        return self
+
+    def getModuleDescriptionRef(self) -> RefType:
+        return self.moduleDescriptionRef
+
+    def setModuleDescriptionRef(self, value: RefType):
+        self.moduleDescriptionRef = value
+        return self
+
+    def getPostBuildVariantUsed(self) -> ARBoolean:
+        return self.postBuildVariantUsed
+
+    def setPostBuildVariantUsed(self, value: ARBoolean):
+        self.postBuildVariantUsed = value
+        return self
+

armodel/models/m2/autosar_templates/sw_component_template/communication.py

@@ -0,0 +1,316 @@
+from abc import ABCMeta
+from typing import List
+
+
+from .....models.ar_object import ARNumerical, ARObject, ARLiteral, ARBoolean, ARPositiveInteger
+from .....models.ar_ref import RefType
+from .....models.communication import CompositeNetworkRepresentation, TransmissionAcknowledgementRequest
+from ...msr.data_dictionary.data_def_properties import SwDataDefProps
+from ..common_structure import ValueSpecification
+
+class PPortComSpec(ARObject, metaclass = ABCMeta):
+    """
+        Communication attributes of a provided PortPrototype. This class will contain attributes that are valid for
+        all kinds of provide ports, independent of client-server or sender-receiver communication patterns.
+
+        Abstract Class 
+
+        Package: M2::AUTOSARTemplates::SWComponentTemplate::Communication
+        Base: ARObject
+    """
+
+    def __init__(self):
+        if type(self) == PPortComSpec:
+            raise NotImplementedError("PPortComSpec is an abstract class.")
+        super().__init__()
+
+
+class RPortComSpec(ARObject, metaclass = ABCMeta):
+    """
+        Communication attributes of a provided PortPrototype. This class will contain attributes that are valid for
+        all kinds of provide ports, independent of client-server or sender-receiver communication patterns.
+
+        Abstract Class 
+
+        Package: M2::AUTOSARTemplates::SWComponentTemplate::Communication
+        Base: ARObject
+    """
+
+    def __init__(self):
+        if type(self) == RPortComSpec:
+            raise NotImplementedError("RPortComSpec is an abstract class.")
+        
+        super().__init__()
+
+
+class SenderComSpec(PPortComSpec, metaclass = ABCMeta):
+    def __init__(self):
+        if type(self) == SenderComSpec:
+            raise NotImplementedError("SenderComSpec is an abstract class.")
+        
+        super().__init__()
+
+        self.compositeNetworkRepresentations = []       # type: List[CompositeNetworkRepresentation]
+        self.dataElementRef = None                      # type: RefType
+        self.networkRepresentation = None               # type: SwDataDefProps
+        self.handleOutOfRange = None                    # type: str
+        self.transmissionAcknowledge = None             # type: TransmissionAcknowledgementRequest 
+        self.usesEndToEndProtection = None              # type: ARBoolean
+
+    def addCompositeNetworkRepresentation(self, representation: CompositeNetworkRepresentation):
+        self.compositeNetworkRepresentations.append(representation)
+
+    def getCompositeNetworkRepresentations(self) -> List[CompositeNetworkRepresentation]:
+        return self.compositeNetworkRepresentations
+    
+    def getDataElementRef(self):
+        return self.dataElementRef
+
+    def setDataElementRef(self, value):
+        self.dataElementRef = value
+        return self
+
+    def getNetworkRepresentation(self):
+        return self.networkRepresentation
+
+    def setNetworkRepresentation(self, value):
+        self.networkRepresentation = value
+        return self
+
+    def getHandleOutOfRange(self):
+        return self.handleOutOfRange
+
+    def setHandleOutOfRange(self, value):
+        self.handleOutOfRange = value
+        return self
+
+    def getTransmissionAcknowledge(self):
+        return self.transmissionAcknowledge
+
+    def setTransmissionAcknowledge(self, value):
+        self.transmissionAcknowledge = value
+        return self
+
+    def getUsesEndToEndProtection(self):
+        return self.usesEndToEndProtection
+
+    def setUsesEndToEndProtection(self, value):
+        self.usesEndToEndProtection = value
+        return self
+
+class QueuedSenderComSpec(SenderComSpec):
+    def __init__(self):
+        super().__init__()
+
+class NonqueuedSenderComSpec(SenderComSpec):
+    def __init__(self):
+        super().__init__()
+        
+        self.initValue = None                               # type: ValueSpecification 
+
+    def getInitValue(self):
+        return self.initValue
+
+    def setInitValue(self, value):
+        self.initValue = value
+        return self
+
+class ClientComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.operationRef = None                            # type: RefType
+
+    def getOperationRef(self):
+        return self.operationRef
+
+    def setOperationRef(self, value):
+        self.operationRef = value
+        return self
+
+class ModeSwitchReceiverComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.modeGroupRef = None                            # type: RefType
+
+    def getModeGroupRef(self):
+        return self.modeGroupRef
+
+    def setModeGroupRef(self, value):
+        self.modeGroupRef = value
+        return self
+
+class NvRequireComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+class ParameterRequireComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+
+class ReceiverComSpec(RPortComSpec):
+    __metaclass__ = ABCMeta
+
+    def __init__(self):
+        super().__init__()
+
+        self.compositeNetworkRepresentations = []       # type: List[CompositeNetworkRepresentation]
+        self.dataElementRef = None                      # type: RefType
+        self.networkRepresentation = None               # type: SwDataDefProps
+        self.handleOutOfRange = None                    # type: ARLiteral
+        self.usesEndToEndProtection = None              # type: ARBoolean     
+
+    def addCompositeNetworkRepresentation(self, representation: CompositeNetworkRepresentation):
+        self.compositeNetworkRepresentations.append(representation)
+
+    def getCompositeNetworkRepresentations(self) -> List[CompositeNetworkRepresentation]:
+        return self.compositeNetworkRepresentations
+
+class ModeSwitchSenderComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.enhancedModeApi = None                     # type: ARBoolean
+        self.modeGroupRef = None                        # type: RefType
+        self.modeSwitchedAck = None                     # type: ModeSwitchedAckRequest
+        self.queueLength = None                         # type: ARPositiveInteger
+
+    def getEnhancedModeApi(self):
+        return self.enhancedModeApi
+
+    def setEnhancedModeApi(self, value):
+        self.enhancedModeApi = value
+        return self
+
+    def getModeGroupRef(self):
+        return self.modeGroupRef
+
+    def setModeGroupRef(self, value):
+        self.modeGroupRef = value
+        return self
+
+    def getModeSwitchedAck(self):
+        return self.modeSwitchedAck
+
+    def setModeSwitchedAck(self, value):
+        self.modeSwitchedAck = value
+        return self
+
+    def getQueueLength(self):
+        return self.queueLength
+
+    def setQueueLength(self, value):
+        self.queueLength = value
+        return self
+
+
+
+class ParameterProvideComSpec(RPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+class ServerComSpec(PPortComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.operationRef = None                    # type: RefType
+        self.queueLength = None                     # type: ARNumerical
+
+    def getOperationRef(self):
+        return self.operationRef
+
+    def setOperationRef(self, value):
+        self.operationRef = value
+        return self
+
+    def getQueueLength(self):
+        return self.queueLength
+
+    def setQueueLength(self, value):
+        self.queueLength = value
+        return self
+
+class NonqueuedReceiverComSpec(ReceiverComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.aliveTimeout = None                # type: ARNumerical
+        self.enableUpdated = None               # type: ARBoolean
+        self.filter = None                      # type: DataFilter
+        self.handleDataStatus = None            # type: ARBoolean
+        self.handleNeverReceived = None         # type: ARBoolean
+        self.handleTimeoutType = ""
+        self.initValue = None                   # type: ValueSpecification
+        self.timeoutSubstitution = None         # type: ValueSpecification
+
+    def getAliveTimeout(self):
+        return self.aliveTimeout
+
+    def setAliveTimeout(self, value):
+        self.aliveTimeout = value
+        return self
+
+    def getEnableUpdated(self):
+        return self.enableUpdated
+
+    def setEnableUpdated(self, value):
+        self.enableUpdated = value
+        return self
+
+    def getFilter(self):
+        return self.filter
+
+    def setFilter(self, value):
+        self.filter = value
+        return self
+
+    def getHandleDataStatus(self):
+        return self.handleDataStatus
+
+    def setHandleDataStatus(self, value):
+        self.handleDataStatus = value
+        return self
+
+    def getHandleNeverReceived(self):
+        return self.handleNeverReceived
+
+    def setHandleNeverReceived(self, value):
+        self.handleNeverReceived = value
+        return self
+
+    def getHandleTimeoutType(self):
+        return self.handleTimeoutType
+
+    def setHandleTimeoutType(self, value):
+        self.handleTimeoutType = value
+        return self
+
+    def getInitValue(self):
+        return self.initValue
+
+    def setInitValue(self, value):
+        self.initValue = value
+        return self
+
+    def getTimeoutSubstitution(self):
+        return self.timeoutSubstitution
+
+    def setTimeoutSubstitution(self, value):
+        self.timeoutSubstitution = value
+        return self
+
+
+class QueuedReceiverComSpec(ReceiverComSpec):
+    def __init__(self):
+        super().__init__()
+
+        self.queueLength = None                    # type: ARPositiveInteger 
+
+    def getQueueLength(self):
+        return self.queueLength
+
+    def setQueueLength(self, value):
+        self.queueLength = value
+        return self