Package org.palladiosimulator.pcm.parameter

Interface VariableUsage

All Superinterfaces:

org.eclipse.emf.cdo.CDOObject, org.eclipse.emf.cdo.common.id.CDOWithID, EObject, Notifier, PCMBaseClass, PCMClass

All Known Implementing Classes:

VariableUsageImpl

public interface VariableUsage
extends PCMBaseClass

A representation of the model object 'Variable Usage'. Variable usages are used to characterise variables like input and output variables or component parameters. They contain the specification of the variable as VariableCharacterisation and also refer to the name of the characterised variable in its namedReference association. Note that it was an explicit design decision to refer to variable names instead of the actual variables (i.e., by refering to Parameter class). It eased the writing of transformations (DSolver as well as SimuCom) but put some complexity in the frontend for entering the variable usages.

The following features are supported:

• Variable Characterisation Variable Usage
• User Data Variable Usage
• Call Action Variable Usage
• Synchronisation Point Variable Usage
• Call Return Action Variable Usage
• Set Variable Action Variable Usage
• Specified Output Parameter Abstraction expected External Outputs Variable Usage
• Assembly Context Variable Usage
• Entry Level System Call Input Parameter Usage
• Entry Level System Call Output Parameter Usage
• Named Reference Variable Usage

See Also:

• ParameterPackage.getVariableUsage()

Generated class or method.

EMF model class or method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	copyright

Method Summary

Modifier and Type	Method	Description
AssemblyContext	getAssemblyContext__VariableUsage()	Returns the value of the 'Assembly Context Variable Usage' container reference.
CallAction	getCallAction__VariableUsage()	Returns the value of the 'Call Action Variable Usage' container reference.
CallReturnAction	getCallReturnAction__VariableUsage()	Returns the value of the 'Call Return Action Variable Usage' container reference.
EntryLevelSystemCall	getEntryLevelSystemCall_InputParameterUsage()	Returns the value of the 'Entry Level System Call Input Parameter Usage' container reference.
EntryLevelSystemCall	getEntryLevelSystemCall_OutputParameterUsage()	Returns the value of the 'Entry Level System Call Output Parameter Usage' container reference.
de.uka.ipd.sdq.stoex.AbstractNamedReference	getNamedReference__VariableUsage()	Returns the value of the 'Named Reference Variable Usage' containment reference.
SetVariableAction	getSetVariableAction_VariableUsage()	Returns the value of the 'Set Variable Action Variable Usage' container reference.
SpecifiedOutputParameterAbstraction	getSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage()	Returns the value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference.
SynchronisationPoint	getSynchronisationPoint_VariableUsage()	Returns the value of the 'Synchronisation Point Variable Usage' container reference.
UserData	getUserData_VariableUsage()	Returns the value of the 'User Data Variable Usage' container reference.
EList<VariableCharacterisation>	getVariableCharacterisation_VariableUsage()	Returns the value of the 'Variable Characterisation Variable Usage' containment reference list.
void	setAssemblyContext__VariableUsage(AssemblyContext value)	Sets the value of the 'Assembly Context Variable Usage' container reference.
void	setCallAction__VariableUsage(CallAction value)	Sets the value of the 'Call Action Variable Usage' container reference.
void	setCallReturnAction__VariableUsage(CallReturnAction value)	Sets the value of the 'Call Return Action Variable Usage' container reference.
void	setEntryLevelSystemCall_InputParameterUsage(EntryLevelSystemCall value)	Sets the value of the 'Entry Level System Call Input Parameter Usage' container reference.
void	setEntryLevelSystemCall_OutputParameterUsage(EntryLevelSystemCall value)	Sets the value of the 'Entry Level System Call Output Parameter Usage' container reference.
void	setNamedReference__VariableUsage(de.uka.ipd.sdq.stoex.AbstractNamedReference value)	Sets the value of the 'Named Reference Variable Usage' containment reference.
void	setSetVariableAction_VariableUsage(SetVariableAction value)	Sets the value of the 'Set Variable Action Variable Usage' container reference.
void	setSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage(SpecifiedOutputParameterAbstraction value)	Sets the value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference.
void	setSynchronisationPoint_VariableUsage(SynchronisationPoint value)	Sets the value of the 'Synchronisation Point Variable Usage' container reference.
void	setUserData_VariableUsage(UserData value)	Sets the value of the 'User Data Variable Usage' container reference.

Methods inherited from interface org.eclipse.emf.cdo.CDOObject

cdoConflict, cdoDirectResource, cdoHistory, cdoID, cdoInvalid, cdoLockState, cdoPermission, cdoPrefetch, cdoReadLock, cdoReload, cdoResource, cdoRevision, cdoRevision, cdoState, cdoView, cdoWriteLock, cdoWriteOption

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

Field Details

copyright

static final String copyright

See Also:

• Constant Field Values

Generated class or method.

Method Details

getVariableCharacterisation_VariableUsage

EList<VariableCharacterisation> getVariableCharacterisation_VariableUsage()

Returns the value of the 'Variable Characterisation Variable Usage' containment reference list. The list contents are of type VariableCharacterisation. It is bidirectional and its opposite is 'Variable Usage Variable Characterisation'. This association contains the information which abstract information on a specific variable is available. For example, whether we know something on the variable's value, its structure or memory footprint. There can be multiple characterisations of the same variable if more than one type of information is available.

Returns:

the value of the 'Variable Characterisation Variable Usage' containment reference list.

See Also:

• ParameterPackage.getVariableUsage_VariableCharacterisation_VariableUsage()
• VariableCharacterisation.getVariableUsage_VariableCharacterisation()

Generated class or method.

EMF model class or method.

opposite="variableUsage_VariableCharacterisation" containment="true" ordered="false"

getUserData_VariableUsage

UserData getUserData_VariableUsage()

Returns the value of the 'User Data Variable Usage' container reference. It is bidirectional and its opposite is 'User Data Parameter Usages User Data'.

Returns:

the value of the 'User Data Variable Usage' container reference.

See Also:

• setUserData_VariableUsage(UserData)
• ParameterPackage.getVariableUsage_UserData_VariableUsage()
• UserData.getUserDataParameterUsages_UserData()

Generated class or method.

EMF model class or method.

opposite="userDataParameterUsages_UserData" transient="false" ordered="false"

setUserData_VariableUsage

void setUserData_VariableUsage(UserData value)

Sets the value of the 'User Data Variable Usage' container reference.

Parameters:

value - the new value of the 'User Data Variable Usage' container reference.

See Also:

• getUserData_VariableUsage()

Generated class or method.

getCallAction__VariableUsage

CallAction getCallAction__VariableUsage()

Returns the value of the 'Call Action Variable Usage' container reference. It is bidirectional and its opposite is 'Input Variable Usages Call Action'.

Returns:

the value of the 'Call Action Variable Usage' container reference.

See Also:

• setCallAction__VariableUsage(CallAction)
• ParameterPackage.getVariableUsage_CallAction__VariableUsage()
• CallAction.getInputVariableUsages__CallAction()

Generated class or method.

EMF model class or method.

opposite="inputVariableUsages__CallAction" transient="false" ordered="false"

setCallAction__VariableUsage

void setCallAction__VariableUsage(CallAction value)

Sets the value of the 'Call Action Variable Usage' container reference.

Parameters:

value - the new value of the 'Call Action Variable Usage' container reference.

See Also:

• getCallAction__VariableUsage()

Generated class or method.

getSynchronisationPoint_VariableUsage

SynchronisationPoint getSynchronisationPoint_VariableUsage()

Returns the value of the 'Synchronisation Point Variable Usage' container reference. It is bidirectional and its opposite is 'Output Parameter Usage Synchronisation Point'.

Returns:

the value of the 'Synchronisation Point Variable Usage' container reference.

See Also:

• setSynchronisationPoint_VariableUsage(SynchronisationPoint)
• ParameterPackage.getVariableUsage_SynchronisationPoint_VariableUsage()
• SynchronisationPoint.getOutputParameterUsage_SynchronisationPoint()

Generated class or method.

EMF model class or method.

opposite="outputParameterUsage_SynchronisationPoint" transient="false" ordered="false"

setSynchronisationPoint_VariableUsage

void setSynchronisationPoint_VariableUsage(SynchronisationPoint value)

Sets the value of the 'Synchronisation Point Variable Usage' container reference.

Parameters:

value - the new value of the 'Synchronisation Point Variable Usage' container reference.

See Also:

• getSynchronisationPoint_VariableUsage()

Generated class or method.

getCallReturnAction__VariableUsage

CallReturnAction getCallReturnAction__VariableUsage()

Returns the value of the 'Call Return Action Variable Usage' container reference. It is bidirectional and its opposite is 'Return Variable Usage Call Return Action'.

Returns:

the value of the 'Call Return Action Variable Usage' container reference.

See Also:

• setCallReturnAction__VariableUsage(CallReturnAction)
• ParameterPackage.getVariableUsage_CallReturnAction__VariableUsage()
• CallReturnAction.getReturnVariableUsage__CallReturnAction()

Generated class or method.

EMF model class or method.

opposite="returnVariableUsage__CallReturnAction" transient="false" ordered="false"

setCallReturnAction__VariableUsage

void setCallReturnAction__VariableUsage(CallReturnAction value)

Sets the value of the 'Call Return Action Variable Usage' container reference.

Parameters:

value - the new value of the 'Call Return Action Variable Usage' container reference.

See Also:

• getCallReturnAction__VariableUsage()

Generated class or method.

getSetVariableAction_VariableUsage

SetVariableAction getSetVariableAction_VariableUsage()

Returns the value of the 'Set Variable Action Variable Usage' container reference. It is bidirectional and its opposite is 'Local Variable Usages Set Variable Action'.

Returns:

the value of the 'Set Variable Action Variable Usage' container reference.

See Also:

• setSetVariableAction_VariableUsage(SetVariableAction)
• ParameterPackage.getVariableUsage_SetVariableAction_VariableUsage()
• SetVariableAction.getLocalVariableUsages_SetVariableAction()

Generated class or method.

EMF model class or method.

opposite="localVariableUsages_SetVariableAction" transient="false" ordered="false"

setSetVariableAction_VariableUsage

void setSetVariableAction_VariableUsage(SetVariableAction value)

Sets the value of the 'Set Variable Action Variable Usage' container reference.

Parameters:

value - the new value of the 'Set Variable Action Variable Usage' container reference.

See Also:

• getSetVariableAction_VariableUsage()

Generated class or method.

getSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage

SpecifiedOutputParameterAbstraction getSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage()

Returns the value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference. It is bidirectional and its opposite is 'Expected External Outputs Specified Output Parameter Abstraction'.

Returns:

the value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference.

See Also:

• setSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage(SpecifiedOutputParameterAbstraction)
• ParameterPackage.getVariableUsage_SpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage()
• SpecifiedOutputParameterAbstraction.getExpectedExternalOutputs_SpecifiedOutputParameterAbstraction()

Generated class or method.

EMF model class or method.

opposite="expectedExternalOutputs_SpecifiedOutputParameterAbstraction" transient="false" ordered="false"

setSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage

void setSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage(SpecifiedOutputParameterAbstraction value)

Sets the value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference.

Parameters:

value - the new value of the 'Specified Output Parameter Abstraction expected External Outputs Variable Usage' container reference.

See Also:

• getSpecifiedOutputParameterAbstraction_expectedExternalOutputs_VariableUsage()

Generated class or method.

getAssemblyContext__VariableUsage

AssemblyContext getAssemblyContext__VariableUsage()

Returns the value of the 'Assembly Context Variable Usage' container reference. It is bidirectional and its opposite is 'Config Parameter Usages Assembly Context'.

Returns:

the value of the 'Assembly Context Variable Usage' container reference.

See Also:

• setAssemblyContext__VariableUsage(AssemblyContext)
• ParameterPackage.getVariableUsage_AssemblyContext__VariableUsage()
• AssemblyContext.getConfigParameterUsages__AssemblyContext()

Generated class or method.

EMF model class or method.

opposite="configParameterUsages__AssemblyContext" transient="false" ordered="false"

setAssemblyContext__VariableUsage

void setAssemblyContext__VariableUsage(AssemblyContext value)

Sets the value of the 'Assembly Context Variable Usage' container reference.

Parameters:

value - the new value of the 'Assembly Context Variable Usage' container reference.

See Also:

• getAssemblyContext__VariableUsage()

Generated class or method.

getEntryLevelSystemCall_InputParameterUsage

EntryLevelSystemCall getEntryLevelSystemCall_InputParameterUsage()

Returns the value of the 'Entry Level System Call Input Parameter Usage' container reference. It is bidirectional and its opposite is 'Input Parameter Usages Entry Level System Call'.

Returns:

the value of the 'Entry Level System Call Input Parameter Usage' container reference.

See Also:

• setEntryLevelSystemCall_InputParameterUsage(EntryLevelSystemCall)
• ParameterPackage.getVariableUsage_EntryLevelSystemCall_InputParameterUsage()
• EntryLevelSystemCall.getInputParameterUsages_EntryLevelSystemCall()

Generated class or method.

EMF model class or method.

opposite="inputParameterUsages_EntryLevelSystemCall" transient="false" ordered="false"

setEntryLevelSystemCall_InputParameterUsage

void setEntryLevelSystemCall_InputParameterUsage(EntryLevelSystemCall value)

Sets the value of the 'Entry Level System Call Input Parameter Usage' container reference.

Parameters:

value - the new value of the 'Entry Level System Call Input Parameter Usage' container reference.

See Also:

• getEntryLevelSystemCall_InputParameterUsage()

Generated class or method.

getEntryLevelSystemCall_OutputParameterUsage

EntryLevelSystemCall getEntryLevelSystemCall_OutputParameterUsage()

Returns the value of the 'Entry Level System Call Output Parameter Usage' container reference. It is bidirectional and its opposite is 'Output Parameter Usages Entry Level System Call'.

Returns:

the value of the 'Entry Level System Call Output Parameter Usage' container reference.

See Also:

• setEntryLevelSystemCall_OutputParameterUsage(EntryLevelSystemCall)
• ParameterPackage.getVariableUsage_EntryLevelSystemCall_OutputParameterUsage()
• EntryLevelSystemCall.getOutputParameterUsages_EntryLevelSystemCall()

Generated class or method.

EMF model class or method.

opposite="outputParameterUsages_EntryLevelSystemCall" transient="false" ordered="false"

setEntryLevelSystemCall_OutputParameterUsage

void setEntryLevelSystemCall_OutputParameterUsage(EntryLevelSystemCall value)

Sets the value of the 'Entry Level System Call Output Parameter Usage' container reference.

Parameters:

value - the new value of the 'Entry Level System Call Output Parameter Usage' container reference.

See Also:

• getEntryLevelSystemCall_OutputParameterUsage()

Generated class or method.

getNamedReference__VariableUsage

de.uka.ipd.sdq.stoex.AbstractNamedReference getNamedReference__VariableUsage()

Returns the value of the 'Named Reference Variable Usage' containment reference.

Returns:

the value of the 'Named Reference Variable Usage' containment reference.

See Also:

• setNamedReference__VariableUsage(AbstractNamedReference)
• ParameterPackage.getVariableUsage_NamedReference__VariableUsage()

Generated class or method.

EMF model class or method.

containment="true" required="true" ordered="false"

setNamedReference__VariableUsage

void setNamedReference__VariableUsage(de.uka.ipd.sdq.stoex.AbstractNamedReference value)

Sets the value of the 'Named Reference Variable Usage' containment reference.

Parameters:

value - the new value of the 'Named Reference Variable Usage' containment reference.

See Also:

• getNamedReference__VariableUsage()

Generated class or method.