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

All Known Implementing Classes:

VariableCharacterisationImpl

public interface VariableCharacterisation

A representation of the model object 'Variable Characterisation'. Variable characterisations store performance critical meta-information on a variable. For example, if a variable's value is used in a long running loop, the value of the variable is performance critical. Or as an other example, for Q-Sort it is performancewise important to know how much elements are in a given array and whether the array is sorted or not. Variable characterisations contain a type which tells what kind of meta-information is stored (STRUCTURE, NUMBER_OF_ELEMENTS, ...) and a PCMRandomVariable for storing the value of the characterisation. For example, in "a.NUMBER_OF_ELEMENTS=10" the a is the name of the variable, NUMBER_OF_ELEMENTS is the characterisation type and "10" would be the specification (as PCMRandomVariable) of the characterisation's value.

The following features are supported:

• Type
• Specification Variable Characterisation

See Also:

ParameterPackage.getVariableCharacterisation()

Field Summary

static String

copyright

Method Summary

PCMRandomVariable	getSpecification_VariableCharacterisation() Returns the value of the 'Specification Variable Characterisation' containment reference.
VariableCharacterisationType	getType() Returns the value of the 'Type' attribute.
void	setSpecification_VariableCharacterisation(PCMRandomVariable value) Sets the value of the 'Specification Variable Characterisation' containment reference.
void	setType(VariableCharacterisationType value) Sets the value of the 'Type' attribute.

Field Detail

copyright

static final String copyright

See Also:

Constant Field Values

Method Detail

getType

VariableCharacterisationType getType()

Returns the value of the 'Type' attribute. The literals are from the enumeration VariableCharacterisationType.

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

The type specifies the kind of the variable characterisation. There are 5 types available: STRUCTURE, NUMBER_OF_ELEMENTS, VALUE, BYTESIZE, and TYPE.

Returns:

the value of the 'Type' attribute.

See Also:

VariableCharacterisationType, setType(VariableCharacterisationType), ParameterPackage.getVariableCharacterisation_Type()

setType

void setType(VariableCharacterisationType value)

Sets the value of the 'Type' attribute.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

VariableCharacterisationType, getType()

getSpecification_VariableCharacterisation

PCMRandomVariable getSpecification_VariableCharacterisation()

Returns the value of the 'Specification Variable Characterisation' containment reference.

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

The specification contains the value of a variable characterisation. It is a stoachastic expression which may also contain references to other variable characterisations (that is the reason why it is a PCMRandomVariable).

Returns:

the value of the 'Specification Variable Characterisation' containment reference.

See Also:

setSpecification_VariableCharacterisation(PCMRandomVariable), ParameterPackage.getVariableCharacterisation_Specification_VariableCharacterisation()

setSpecification_VariableCharacterisation

void setSpecification_VariableCharacterisation(PCMRandomVariable value)

Sets the value of the 'Specification Variable Characterisation' containment reference.

Parameters:

value - the new value of the 'Specification Variable Characterisation' containment reference.

See Also:

getSpecification_VariableCharacterisation()