armodel 1.5.0__py3-none-any.whl → 1.6.1__py3-none-any.whl

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

@@ -0,0 +1,360 @@
+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__()
+
+        self.initValue = None                           # type: ValueSpecification
+        self.parameterRef = None                        # type: RefType
+
+    def getInitValue(self):
+        return self.initValue
+
+    def setInitValue(self, value):
+        self.initValue = value
+        return self
+
+    def getParameterRef(self):
+        return self.parameterRef
+
+    def setParameterRef(self, value):
+        self.parameterRef = value
+        return self
+
+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 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 getUsesEndToEndProtection(self):
+        return self.usesEndToEndProtection
+
+    def setUsesEndToEndProtection(self, value):
+        self.usesEndToEndProtection = value
+        return self
+
+    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

armodel/models/m2/autosar_templates/sw_component_template/components/__init__.py

@@ -0,0 +1,246 @@
+from abc import ABCMeta
+from typing import List
+
+
+
+from .....ar_ref import RefType, TRefType
+from .....general_structure import ARElement, Identifiable
+from .....ar_object import ARBoolean, ARObject
+from ...common_structure.implementation import ImplementationProps
+from ..communication import ClientComSpec, ModeSwitchReceiverComSpec, ModeSwitchSenderComSpec, NonqueuedReceiverComSpec, NonqueuedSenderComSpec, PPortComSpec, ParameterRequireComSpec, QueuedReceiverComSpec, QueuedSenderComSpec, RPortComSpec, ServerComSpec
+from .instance_refs import InnerPortGroupInCompositionInstanceRef
+
+class SymbolProps(ImplementationProps):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+class PortPrototype(Identifiable):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.clientServerAnnotations = []
+        self.delegatedPortAnnotation = None
+        self.ioHwAbstractionServerAnnotations = []
+        self.modePortAnnotations = []
+        self.nvDataPortAnnotations = []
+        self.parameterPortAnnotations = []
+        self.senderReceiverAnnotations = []
+        self.triggerPortAnnotations = []
+
+    def getClientServerAnnotations(self):
+        return self.clientServerAnnotations
+
+    def addClientServerAnnotation(self, value):
+        self.clientServerAnnotations.append(value)
+        return self
+
+    def getDelegatedPortAnnotation(self):
+        return self.delegatedPortAnnotation
+
+    def setDelegatedPortAnnotation(self, value):
+        self.delegatedPortAnnotation = value
+        return self
+
+    def getIoHwAbstractionServerAnnotations(self):
+        return self.ioHwAbstractionServerAnnotations
+
+    def addIoHwAbstractionServerAnnotation(self, value):
+        self.ioHwAbstractionServerAnnotations.append(value)
+        return self
+
+    def getModePortAnnotations(self):
+        return self.modePortAnnotations
+
+    def addModePortAnnotation(self, value):
+        self.modePortAnnotations.append(value)
+        return self
+
+    def getNvDataPortAnnotations(self):
+        return self.nvDataPortAnnotations
+
+    def addNvDataPortAnnotation(self, value):
+        self.nvDataPortAnnotations.append(value)
+        return self
+
+    def getParameterPortAnnotations(self):
+        return self.parameterPortAnnotations
+
+    def addParameterPortAnnotation(self, value):
+        self.parameterPortAnnotations.append(value)
+        return self
+
+    def getSenderReceiverAnnotations(self):
+        return self.senderReceiverAnnotations
+
+    def addSenderReceiverAnnotation(self, value):
+        self.senderReceiverAnnotations.append(value)
+        return self
+
+    def getTriggerPortAnnotations(self):
+        return self.triggerPortAnnotations
+
+    def addTriggerPortAnnotation(self, value):
+        self.triggerPortAnnotations.append(value)
+        return self
+
+class AbstractProvidedPortPrototype(PortPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.provided_com_specs = []  # type: List[PPortComSpec]
+
+    def _validateRPortComSpec(self, com_spec: PPortComSpec):
+        if isinstance(com_spec, NonqueuedSenderComSpec):
+            if com_spec.dataElementRef == None:
+                raise ValueError(
+                    "operation of NonqueuedSenderComSpec is invalid")
+            if com_spec.dataElementRef.dest != "VARIABLE-DATA-PROTOTYPE":
+                raise ValueError(
+                    "Invalid operation dest of NonqueuedSenderComSpec")
+        elif isinstance(com_spec, ServerComSpec):
+            pass
+        elif isinstance(com_spec, QueuedSenderComSpec):
+            pass
+        elif isinstance(com_spec, ModeSwitchSenderComSpec):
+            pass
+        else:
+            raise ValueError("Unsupported com spec")
+
+    def addProvidedComSpec(self, com_spec):
+        self._validateRPortComSpec(com_spec)
+        self.provided_com_specs.append(com_spec)
+
+    def getProvidedComSpecs(self) -> List[PPortComSpec]:
+        return self.provided_com_specs
+
+    def getNonqueuedSenderComSpecs(self) -> List[NonqueuedSenderComSpec]:
+        return filter(lambda c: isinstance(c, NonqueuedSenderComSpec), self.provided_com_specs)
+
+
+class AbstractRequiredPortPrototype(PortPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.required_com_specs = []  # type: List[RPortComSpec]
+
+    def _validateRPortComSpec(self, com_spec: RPortComSpec):
+        if (isinstance(com_spec, ClientComSpec)):
+            if com_spec.getOperationRef() is not None:
+                if com_spec.getOperationRef().getDest() != "CLIENT-SERVER-OPERATION":
+                    raise ValueError("Invalid operation dest of ClientComSpec.")
+        elif isinstance(com_spec, NonqueuedReceiverComSpec):
+            if com_spec.getDataElementRef() is not None:
+                if com_spec.getDataElementRef().getDest() != "VARIABLE-DATA-PROTOTYPE":
+                    raise ValueError("Invalid date element dest of NonqueuedReceiverComSpec.")
+        elif isinstance(com_spec, QueuedReceiverComSpec):
+            pass
+        elif isinstance(com_spec, ModeSwitchReceiverComSpec):
+            pass
+        elif isinstance(com_spec, ParameterRequireComSpec):
+            if com_spec.getParameterRef() is not None:
+                if com_spec.getParameterRef().getDest() != "PARAMETER-DATA-PROTOTYPE":
+                    raise ValueError("Invalid parameter dest of ParameterRequireComSpec.")
+        else:
+            raise ValueError("Unsupported RPortComSpec <%s>" % type(com_spec))
+
+    def addRequiredComSpec(self, com_spec: RPortComSpec):
+        self._validateRPortComSpec(com_spec)
+        self.required_com_specs.append(com_spec)
+
+    def getRequiredComSpecs(self) -> List[RPortComSpec]:
+        return self.required_com_specs
+
+    def getClientComSpecs(self) -> List[ClientComSpec]:
+        return filter(lambda c: isinstance(c, ClientComSpec), self.required_com_specs)
+
+    def getNonqueuedReceiverComSpecs(self) -> List[NonqueuedReceiverComSpec]:
+        return filter(lambda c: isinstance(c, NonqueuedReceiverComSpec), self.required_com_specs)
+
+
+class PPortPrototype(AbstractProvidedPortPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.providedInterfaceTRef = None           # type: TRefType
+
+    def getProvidedInterfaceTRef(self):
+        return self.providedInterfaceTRef
+
+    def setProvidedInterfaceTRef(self, value):
+        self.providedInterfaceTRef = value
+        return self
+
+class RPortPrototype(AbstractRequiredPortPrototype):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self.mayBeUnconnected = None                # type: ARBoolean
+        self.requiredInterfaceTRef = None           # type: TRefType
+
+    def getMayBeUnconnected(self):
+        return self.mayBeUnconnected
+
+    def setMayBeUnconnected(self, value):
+        self.mayBeUnconnected = value
+        return self
+
+    def getRequiredInterfaceTRef(self):
+        return self.requiredInterfaceTRef
+
+    def setRequiredInterfaceTRef(self, value):
+        self.requiredInterfaceTRef = value
+        return self
+
+class PortGroup(Identifiable):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+        self._inner_group_iref = []    # type: List[InnerPortGroupInCompositionInstanceRef]
+        self._outer_port_ref = []      # type: List[RefType]
+
+    def addInnerGroupIRef(self, iref: InnerPortGroupInCompositionInstanceRef):
+        self._inner_group_iref.append(iref)
+
+    def getInnerGroupIRefs(self) -> List[InnerPortGroupInCompositionInstanceRef]:
+        return self._inner_group_iref
+    
+    def addOuterPortRef(self, ref: RefType):
+        self._outer_port_ref.append(ref)
+
+    def getOuterPortRefs(self) -> List[RefType]:
+        return self._outer_port_ref
+
+class SwComponentType(ARElement,  metaclass = ABCMeta):
+    def __init__(self, parent: ARObject, short_name: str):
+        super().__init__(parent, short_name)
+
+    def createPPortPrototype(self, short_name: str) -> PPortPrototype:
+        prototype = PPortPrototype(self, short_name)
+        if (short_name not in self.elements):
+            self.elements[short_name] = prototype
+        return self.elements[short_name]
+
+    def createRPortPrototype(self, short_name) -> RPortPrototype:
+        prototype = RPortPrototype(self, short_name)
+        if (short_name not in self.elements):
+            self.elements[short_name] = prototype
+        return self.elements[short_name]
+    
+    def createPortGroup(self, short_name) -> PortGroup:
+        port_group = PortGroup(self, short_name)
+        if (short_name not in self.elements):
+            self.elements[short_name] = port_group
+        return self.elements[short_name]
+
+    def getPPortPrototypes(self) -> List[PPortPrototype]:
+        return list(sorted(filter(lambda c: isinstance(c, PPortPrototype), self.elements.values()), key= lambda o: o.short_name))
+
+    def getRPortPrototypes(self) -> List[RPortPrototype]:
+        return list(sorted(filter(lambda c: isinstance(c, RPortPrototype), self.elements.values()), key= lambda o: o.short_name))
+    
+    def getPortPrototypes(self) -> List[PortPrototype]:
+        return list(sorted(filter(lambda c: isinstance(c, PortPrototype), self.elements.values()), key= lambda o: o.short_name))
+    
+    def getPortGroups(self) -> List[PortGroup]:
+        return list(sorted(filter(lambda c: isinstance(c, PortGroup), self.elements.values()), key= lambda o: o.short_name))
+