de.cau.cs.kieler.core.kexpressions
Interface Signal

All Superinterfaces:
Annotatable, EObject, Notifier, ValuedObject
All Known Subinterfaces:
ISignal
All Known Implementing Classes:
ISignalImpl, SignalImpl

public interface Signal
extends ValuedObject

A representation of the model object 'Signal'. A Signal is the first-class data object in synchronous languages used for communication. Signals extend ValuedObject and therefore have a name and may carry a value. A Signal can be part of a module's interface and therefore be an input, an output (or even both). If a Signal is neither input nor output, it is considered to be a local signal with a limited scope not visible to the outside.

As the value of a Signal is unique in one tick, the interpreter needs to know how to handle multiple emissions of the same Signal in a tick. Therefore a combineOperator can be set. Such operator needs to be commutative. It can be chosen from a pre-defined enumeration or by a String referencing a function in the target language (e.g. a C or Java function name that has exactly two parameters and produces one combined result of the corresponding data type).

The following features are supported:

See Also:
KExpressionsPackage.getSignal()
Rating red
Generated:
This code was automatically generated.
Model element

Method Summary
 CombineOperator getCombineOperator()
          Returns the value of the 'Combine Operator' attribute.
 String getHostCombineOperator()
          Returns the value of the 'Host Combine Operator' attribute.
 boolean isIsInput()
          Returns the value of the 'Is Input' attribute.
 boolean isIsOutput()
          Returns the value of the 'Is Output' attribute.
 void setCombineOperator(CombineOperator value)
          Sets the value of the 'Combine Operator' attribute.
 void setHostCombineOperator(String value)
          Sets the value of the 'Host Combine Operator' attribute.
 void setIsInput(boolean value)
          Sets the value of the 'Is Input' attribute.
 void setIsOutput(boolean value)
          Sets the value of the 'Is Output' attribute.
 
Methods inherited from interface de.cau.cs.kieler.core.kexpressions.ValuedObject
getHostType, getInitialValue, getName, getType, setHostType, setInitialValue, setName, setType
 
Methods inherited from interface de.cau.cs.kieler.core.annotations.Annotatable
getAllAnnotations, getAnnotation, getAnnotations, removeAllAnnotations
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

isIsInput

boolean isIsInput()
Returns the value of the 'Is Input' attribute.

If the meaning of the 'Is Input' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Input' attribute.
See Also:
setIsInput(boolean), KExpressionsPackage.getSignal_IsInput()
Generated:
This code was automatically generated.
Model element:
required=true

setIsInput

void setIsInput(boolean value)
Sets the value of the 'Is Input' attribute.

Parameters:
value - the new value of the 'Is Input' attribute.
See Also:
isIsInput()
Generated:
This code was automatically generated.

isIsOutput

boolean isIsOutput()
Returns the value of the 'Is Output' attribute.

If the meaning of the 'Is Output' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Output' attribute.
See Also:
setIsOutput(boolean), KExpressionsPackage.getSignal_IsOutput()
Generated:
This code was automatically generated.
Model element:
required=true

setIsOutput

void setIsOutput(boolean value)
Sets the value of the 'Is Output' attribute.

Parameters:
value - the new value of the 'Is Output' attribute.
See Also:
isIsOutput()
Generated:
This code was automatically generated.

getCombineOperator

CombineOperator getCombineOperator()
Returns the value of the 'Combine Operator' attribute. The literals are from the enumeration CombineOperator.

If the meaning of the 'Combine Operator' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Combine Operator' attribute.
See Also:
CombineOperator, setCombineOperator(CombineOperator), KExpressionsPackage.getSignal_CombineOperator()
Generated:
This code was automatically generated.
Model element:
required=true

setCombineOperator

void setCombineOperator(CombineOperator value)
Sets the value of the 'Combine Operator' attribute.

Parameters:
value - the new value of the 'Combine Operator' attribute.
See Also:
CombineOperator, getCombineOperator()
Generated:
This code was automatically generated.

getHostCombineOperator

String getHostCombineOperator()
Returns the value of the 'Host Combine Operator' attribute.

If the meaning of the 'Host Combine Operator' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Host Combine Operator' attribute.
See Also:
setHostCombineOperator(String), KExpressionsPackage.getSignal_HostCombineOperator()
Generated:
This code was automatically generated.
Model element

setHostCombineOperator

void setHostCombineOperator(String value)
Sets the value of the 'Host Combine Operator' attribute.

Parameters:
value - the new value of the 'Host Combine Operator' attribute.
See Also:
getHostCombineOperator()
Generated:
This code was automatically generated.