org.eclipse.ocl.pivot.uml.internal.oclforuml

Interface Real

All Known Subinterfaces:

FixedPoint, FloatingPoint

All Known Implementing Classes:

FixedPointImpl, FloatingPointImpl, RealImpl

public interface Real

A representation of the model object 'Real'. Specifies that a DataType behaves as a Real and optionally defines a limited numeric range and resolution that an implementation must support. Computations resulting in values beyond a specified minimum or maximum limits or resolution are ill-defined. The derived FixedPoint or FloatingPoint stereotypes may be used to define more exact precisions, overflow and underflow behaviors.

The following features are supported:

• Base Data Type
• Epsilon
• Maximum
• Minimum

See Also:

OCLforUMLPackage.getReal()

EMF generated code

EMF model element

Method Summary

Modifier and Type	Method and Description
DataType	getBase_DataType() Returns the value of the 'Base Data Type' reference.
double	getEpsilon() Returns the value of the 'Epsilon' attribute.
double	getMaximum() Returns the value of the 'Maximum' attribute.
double	getMinimum() Returns the value of the 'Minimum' attribute.
boolean	isSetEpsilon() Returns whether the value of the 'Epsilon' attribute is set.
boolean	isSetMaximum() Returns whether the value of the 'Maximum' attribute is set.
boolean	isSetMinimum() Returns whether the value of the 'Minimum' attribute is set.
void	setBase_DataType(DataType value) Sets the value of the 'Base Data Type' reference.
void	setEpsilon(double value) Sets the value of the 'Epsilon' attribute.
void	setMaximum(double value) Sets the value of the 'Maximum' attribute.
void	setMinimum(double value) Sets the value of the 'Minimum' attribute.
void	unsetEpsilon() Unsets the value of the 'Epsilon' attribute.
void	unsetMaximum() Unsets the value of the 'Maximum' attribute.
void	unsetMinimum() Unsets the value of the 'Minimum' attribute.

Method Detail

getBase_DataType

DataType getBase_DataType()

Returns the value of the 'Base Data Type' reference.

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

Returns:

the value of the 'Base Data Type' reference.

See Also:

setBase_DataType(DataType), OCLforUMLPackage.getReal_Base_DataType()

EMF generated code

EMF model element

required="true" ordered="false"

setBase_DataType

void setBase_DataType(DataType value)

Sets the value of the 'Base Data Type' reference.

Parameters:

value - the new value of the 'Base Data Type' reference.

See Also:

getBase_DataType()

EMF generated code

getEpsilon

double getEpsilon()

Returns the value of the 'Epsilon' attribute. The minimum required ratio between adjacent values.

Returns:

the value of the 'Epsilon' attribute.

See Also:

isSetEpsilon(), unsetEpsilon(), setEpsilon(double), OCLforUMLPackage.getReal_Epsilon()

EMF generated code

EMF model element

unsettable="true" dataType="org.eclipse.uml2.types.Real" ordered="false"

setEpsilon

void setEpsilon(double value)

Sets the value of the 'Epsilon' attribute.

Parameters:

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

See Also:

isSetEpsilon(), unsetEpsilon(), getEpsilon()

EMF generated code

unsetEpsilon

void unsetEpsilon()

Unsets the value of the 'Epsilon' attribute.

See Also:

isSetEpsilon(), getEpsilon(), setEpsilon(double)

EMF generated code

isSetEpsilon

boolean isSetEpsilon()

Returns whether the value of the 'Epsilon' attribute is set.

Returns:

whether the value of the 'Epsilon' attribute is set.

See Also:

unsetEpsilon(), getEpsilon(), setEpsilon(double)

EMF generated code

getMaximum

double getMaximum()

Returns the value of the 'Maximum' attribute. The most positive inclusive value of the DataType. Defaults to unlimited.

Returns:

the value of the 'Maximum' attribute.

See Also:

isSetMaximum(), unsetMaximum(), setMaximum(double), OCLforUMLPackage.getReal_Maximum()

EMF generated code

EMF model element

unsettable="true" dataType="org.eclipse.uml2.types.Real" ordered="false"

setMaximum

void setMaximum(double value)

Sets the value of the 'Maximum' attribute.

Parameters:

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

See Also:

isSetMaximum(), unsetMaximum(), getMaximum()

EMF generated code

unsetMaximum

void unsetMaximum()

Unsets the value of the 'Maximum' attribute.

See Also:

isSetMaximum(), getMaximum(), setMaximum(double)

EMF generated code

isSetMaximum

boolean isSetMaximum()

Returns whether the value of the 'Maximum' attribute is set.

Returns:

whether the value of the 'Maximum' attribute is set.

See Also:

unsetMaximum(), getMaximum(), setMaximum(double)

EMF generated code

getMinimum

double getMinimum()

Returns the value of the 'Minimum' attribute. The most negative inclusive value of the DataType. Defaults to unlimited.

Returns:

the value of the 'Minimum' attribute.

See Also:

isSetMinimum(), unsetMinimum(), setMinimum(double), OCLforUMLPackage.getReal_Minimum()

EMF generated code

EMF model element

unsettable="true" dataType="org.eclipse.uml2.types.Real" ordered="false"

setMinimum

void setMinimum(double value)

Sets the value of the 'Minimum' attribute.

Parameters:

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

See Also:

isSetMinimum(), unsetMinimum(), getMinimum()

EMF generated code

unsetMinimum

void unsetMinimum()

Unsets the value of the 'Minimum' attribute.

See Also:

isSetMinimum(), getMinimum(), setMinimum(double)

EMF generated code

isSetMinimum

boolean isSetMinimum()

Returns whether the value of the 'Minimum' attribute is set.

Returns:

whether the value of the 'Minimum' attribute is set.

See Also:

unsetMinimum(), getMinimum(), setMinimum(double)

EMF generated code