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

Interface FixedPoint

All Superinterfaces:

Real

All Known Implementing Classes:

FixedPointImpl

public interface FixedPoint
extends Real

A representation of the model object 'Fixed Point'. Specifies that a DataType behaves as a Real number and optionally defines the precision of a fixed point Integer representation. A two bit number with the values {-4, -2, 0, +2} is specified as having three integerBits and -1 fractionalBIts.

The following features are supported:

• Bit True
• Fractional Bits
• Integer Bits
• Overflow
• Rounding

See Also:

OCLforUMLPackage.getFixedPoint()

EMF generated code

EMF model element

Method Summary

Modifier and Type	Method and Description
int	getFractionalBits() Returns the value of the 'Fractional Bits' attribute.
int	getIntegerBits() Returns the value of the 'Integer Bits' attribute.
Overflow	getOverflow() Returns the value of the 'Overflow' attribute.
Rounding	getRounding() Returns the value of the 'Rounding' attribute.
boolean	isBitTrue() Returns the value of the 'Bit True' attribute.
void	setBitTrue(boolean value) Sets the value of the 'Bit True' attribute.
void	setFractionalBits(int value) Sets the value of the 'Fractional Bits' attribute.
void	setIntegerBits(int value) Sets the value of the 'Integer Bits' attribute.
void	setOverflow(Overflow value) Sets the value of the 'Overflow' attribute.
void	setRounding(Rounding value) Sets the value of the 'Rounding' attribute.

Methods inherited from interface org.eclipse.ocl.pivot.uml.internal.oclforuml.Real

getBase_DataType, getEpsilon, getMaximum, getMinimum, isSetEpsilon, isSetMaximum, isSetMinimum, setBase_DataType, setEpsilon, setMaximum, setMinimum, unsetEpsilon, unsetMaximum, unsetMinimum

Method Detail

isBitTrue

boolean isBitTrue()

Returns the value of the 'Bit True' attribute. Specifies that an implementation precisely implements the specified number of fractionBits and so is bit-true. Alternatively a non-bit-true implementation may use a larger fractionalBits to suit the natural precision of a target platform.

Returns:

the value of the 'Bit True' attribute.

See Also:

setBitTrue(boolean), OCLforUMLPackage.getFixedPoint_BitTrue()

EMF generated code

EMF model element

dataType="org.eclipse.uml2.types.Boolean" required="true" ordered="false"

setBitTrue

void setBitTrue(boolean value)

Sets the value of the 'Bit True' attribute.

Parameters:

value - the new value of the 'Bit True' attribute.

See Also:

isBitTrue()

EMF generated code

getFractionalBits

int getFractionalBits()

Returns the value of the 'Fractional Bits' attribute. The default value is "0". The number of bits used to represent the fractional ptrecision of the fixed point number. This may be negative if the fixed point quantum is greater than 1.

Returns:

the value of the 'Fractional Bits' attribute.

See Also:

setFractionalBits(int), OCLforUMLPackage.getFixedPoint_FractionalBits()

EMF generated code

EMF model element

default="0" dataType="org.eclipse.uml2.types.Integer" required="true" ordered="false"

setFractionalBits

void setFractionalBits(int value)

Sets the value of the 'Fractional Bits' attribute.

Parameters:

value - the new value of the 'Fractional Bits' attribute.

See Also:

getFractionalBits()

EMF generated code

getIntegerBits

int getIntegerBits()

Returns the value of the 'Integer Bits' attribute. The number of bits used to represent the sign and non-fractional part of the fixed point number.

Returns:

the value of the 'Integer Bits' attribute.

See Also:

setIntegerBits(int), OCLforUMLPackage.getFixedPoint_IntegerBits()

EMF generated code

EMF model element

dataType="org.eclipse.uml2.types.Integer" required="true" ordered="false"

setIntegerBits

void setIntegerBits(int value)

Sets the value of the 'Integer Bits' attribute.

Parameters:

value - the new value of the 'Integer Bits' attribute.

See Also:

getIntegerBits()

EMF generated code

getOverflow

Overflow getOverflow()

Returns the value of the 'Overflow' attribute. The default value is "invalid". The literals are from the enumeration Overflow. The behavior when a maximum/minimum value is exceeded.

Returns:

the value of the 'Overflow' attribute.

See Also:

Overflow, setOverflow(Overflow), OCLforUMLPackage.getFixedPoint_Overflow()

EMF generated code

EMF model element

default="invalid" required="true" ordered="false"

setOverflow

void setOverflow(Overflow value)

Sets the value of the 'Overflow' attribute.

Parameters:

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

See Also:

Overflow, getOverflow()

EMF generated code

getRounding

Rounding getRounding()

Returns the value of the 'Rounding' attribute. The default value is "nearest". The literals are from the enumeration Rounding. The behavior when there is insufficient resolution.

Returns:

the value of the 'Rounding' attribute.

See Also:

Rounding, setRounding(Rounding), OCLforUMLPackage.getFixedPoint_Rounding()

EMF generated code

EMF model element

default="nearest" required="true" ordered="false"

setRounding

void setRounding(Rounding value)

Sets the value of the 'Rounding' attribute.

Parameters:

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

See Also:

Rounding, getRounding()

EMF generated code