Package org.palladiosimulator.pcm.parameter

Interface VariableCharacterisation

All Superinterfaces:

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

All Known Implementing Classes:

VariableCharacterisationImpl

public interface VariableCharacterisation
extends org.eclipse.emf.cdo.CDOObject

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
• Variable Usage Variable Characterisation

See Also:

ParameterPackage.getVariableCharacterisation()

Generated class or method.

EMF model class or method.

Field Summary

Fields

Modifier and Type	Field	Description
static String	copyright

Method Summary

Modifier and Type	Method	Description
PCMRandomVariable	getSpecification_VariableCharacterisation()	Returns the value of the 'Specification Variable Characterisation' containment reference.
VariableCharacterisationType	getType()	Returns the value of the 'Type' attribute.
VariableUsage	getVariableUsage_VariableCharacterisation()	Returns the value of the 'Variable Usage Variable Characterisation' container reference.
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.
void	setVariableUsage_VariableCharacterisation(VariableUsage value)	Sets the value of the 'Variable Usage Variable Characterisation' 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 Detail

copyright

static final String copyright

See Also:

Constant Field Values

Generated class or method.

Method Detail

getType

VariableCharacterisationType getType()

Returns the value of the 'Type' attribute. The literals are from the enumeration VariableCharacterisationType. 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()

Generated class or method.

EMF model class or method.

required="true"

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

Generated class or method.

getSpecification_VariableCharacterisation

PCMRandomVariable getSpecification_VariableCharacterisation()

Returns the value of the 'Specification Variable Characterisation' containment reference. It is bidirectional and its opposite is ' Variable Characterisation Specification'. 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(), PCMRandomVariable.getVariableCharacterisation_Specification()

Generated class or method.

EMF model class or method.

opposite="variableCharacterisation_Specification" containment="true" required="true"

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

Generated class or method.

getVariableUsage_VariableCharacterisation

VariableUsage getVariableUsage_VariableCharacterisation()

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

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

Returns:

the value of the 'Variable Usage Variable Characterisation' container reference.

See Also:

setVariableUsage_VariableCharacterisation(VariableUsage), ParameterPackage.getVariableCharacterisation_VariableUsage_VariableCharacterisation(), VariableUsage.getVariableCharacterisation_VariableUsage()

Generated class or method.

EMF model class or method.

opposite="variableCharacterisation_VariableUsage" transient="false" ordered="false"

setVariableUsage_VariableCharacterisation

void setVariableUsage_VariableCharacterisation(VariableUsage value)

Sets the value of the 'Variable Usage Variable Characterisation' container reference.

Parameters:

value - the new value of the 'Variable Usage Variable Characterisation' container reference.

See Also:

getVariableUsage_VariableCharacterisation()

Generated class or method.