Package org.palladiosimulator.metricspec

Interface BaseMetricDescription

All Superinterfaces:

org.eclipse.emf.cdo.CDOObject, org.eclipse.emf.cdo.common.id.CDOWithID, Description, EObject, de.uka.ipd.sdq.identifier.Identifier, MetricDescription, Notifier

All Known Subinterfaces:

NumericalBaseMetricDescription, TextualBaseMetricDescription

All Known Implementing Classes:

BaseMetricDescriptionImpl, NumericalBaseMetricDescriptionImpl, TextualBaseMetricDescriptionImpl

public interface BaseMetricDescription
extends MetricDescription

A representation of the model object ' Base Metric Description'. A one-dimensional metric description.

The following features are supported:

• Capture Type
• Data Type
• Scale
• Scope Of Validity

See Also:

MetricSpecPackage.getBaseMetricDescription()

Generated class or method.

EMF model class or method.

abstract="true"

Method Summary

Modifier and Type	Method	Description
CaptureType	getCaptureType()	Returns the value of the 'Capture Type' attribute.
DataType	getDataType()	Returns the value of the 'Data Type' attribute.
Scale	getScale()	Returns the value of the 'Scale' attribute.
ScopeOfValidity	getScopeOfValidity()	Returns the value of the 'Scope Of Validity' attribute.
void	setCaptureType(CaptureType value)	Sets the value of the ' Capture Type' attribute.
void	setDataType(DataType value)	Sets the value of the ' Data Type ' attribute.
void	setScale(Scale value)	Sets the value of the 'Scale' attribute.
void	setScopeOfValidity(ScopeOfValidity value)	Sets the value of the ' Scope Of Validity' attribute.

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.palladiosimulator.metricspec.Description

getName, getTextualDescription, setName, setTextualDescription

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 de.uka.ipd.sdq.identifier.Identifier

getId, setId

Methods inherited from interface org.palladiosimulator.metricspec.MetricDescription

getRepository, setRepository

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getCaptureType

CaptureType getCaptureType()

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

Determines the observable and capturable type for his metric.

Returns:

the value of the 'Capture Type' attribute.

See Also:

CaptureType, setCaptureType(CaptureType), MetricSpecPackage.getBaseMetricDescription_CaptureType()

Generated class or method.

EMF model class or method.

required="true" ordered="false"

setCaptureType

void setCaptureType(CaptureType value)

Sets the value of the ' Capture Type' attribute.

Parameters:

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

See Also:

CaptureType, getCaptureType()

Generated class or method.

getDataType

DataType getDataType()

Returns the value of the 'Data Type' attribute. The literals are from the enumeration DataType. Determines the kind of observable data for this metric. E.g. if it contains quantitative or qualitative data.

Returns:

the value of the 'Data Type' attribute.

See Also:

DataType, setDataType(DataType), MetricSpecPackage.getBaseMetricDescription_DataType()

Generated class or method.

EMF model class or method.

required="true" ordered="false"

setDataType

void setDataType(DataType value)

Sets the value of the ' Data Type ' attribute.

Parameters:

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

See Also:

DataType, getDataType()

Generated class or method.

getScale

Scale getScale()

Returns the value of the 'Scale' attribute. The literals are from the enumeration Scale. Determines the mathematical scale of the metric.

Returns:

the value of the 'Scale' attribute.

See Also:

Scale, setScale(Scale), MetricSpecPackage.getBaseMetricDescription_Scale()

Generated class or method.

EMF model class or method.

required="true" ordered="false"

setScale

void setScale(Scale value)

Sets the value of the 'Scale' attribute.

Parameters:

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

See Also:

Scale, getScale()

Generated class or method.

getScopeOfValidity

ScopeOfValidity getScopeOfValidity()

Returns the value of the 'Scope Of Validity' attribute. The literals are from the enumeration ScopeOfValidity.

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

Returns:

the value of the 'Scope Of Validity' attribute.

See Also:

ScopeOfValidity, setScopeOfValidity(ScopeOfValidity), MetricSpecPackage.getBaseMetricDescription_ScopeOfValidity()

Generated class or method.

EMF model class or method.

required="true"

setScopeOfValidity

void setScopeOfValidity(ScopeOfValidity value)

Sets the value of the ' Scope Of Validity' attribute.

Parameters:

value - the new value of the 'Scope Of Validity' attribute.

See Also:

ScopeOfValidity, getScopeOfValidity()

Generated class or method.