de.uka.ipd.sdq.pcm.parameter
Interface VariableUsage

All Known Implementing Classes:

VariableUsageImpl

public interface VariableUsage

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
• Named Reference Variable Usage

See Also:

ParameterPackage.getVariableUsage()

Field Summary

static String

copyright

Method Summary

AbstractNamedReference	getNamedReference_VariableUsage() Returns the value of the 'Named Reference Variable Usage' containment reference.
	getVariableCharacterisation_VariableUsage() Returns the value of the 'Variable Characterisation Variable Usage' containment reference list.
void	setNamedReference_VariableUsage(AbstractNamedReference value) Sets the value of the 'Named Reference Variable Usage' containment reference.

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getVariableCharacterisation_VariableUsage

 getVariableCharacterisation_VariableUsage()

Returns the value of the 'Variable Characterisation Variable Usage' containment reference list. The list contents are of type VariableCharacterisation.

If the meaning of the 'Variable Characterisation Variable Usage' containment reference list isn't clear, there really should be more of a description here...

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()

getNamedReference_VariableUsage

AbstractNamedReference getNamedReference_VariableUsage()

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

If the meaning of the 'Named Reference Variable Usage' containment reference isn't clear, there really should be more of a description here...

This association is used to store the reference to the characterised variable. The references are of the form "namespace1.namespace2.variable" split up into namespace references and a variable reference. The reference has to identify the referenced variable in a unique way, i.e., no two variables can have the same name in a given scope.

Returns:

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

See Also:

setNamedReference_VariableUsage(AbstractNamedReference), ParameterPackage.getVariableUsage_NamedReference_VariableUsage()

setNamedReference_VariableUsage

void setNamedReference_VariableUsage(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()