Public Member Functions | Package Functions

de.fraunhofer.isst.eastadl.datatypes.RangeableValueType Interface Reference

List of all members.

Public Member Functions

RangeableDatatype getBaseRangeable ()
float getResolution ()
int getSignificantDigits ()
boolean isSetSignificantDigits ()
void setAccuracy (float value)
void setBaseRangeable (RangeableDatatype value)
void setResolution (float value)
void setSignificantDigits (int value)
void unsetSignificantDigits ()

Package Functions

float getAccuracy ()

Detailed Description

RangeableValueType (from Datatypes)

Generalizations
ValueType (from Datatypes)

Description
The RangeableValueType is a specific ValueType applicable for RangeableDatatypes. It describes the accuracy, resolution, and the significant digits of the baseRangeable datatypes.

Attributes

Associations
baseRangeable : RangeableDatatype [1]
- The RangeableDatatype that the RangeableValueType points to.

Constraints
No additional constraints

Semantics
The RangeableValueType adds the ability to describe the accuracy, resolution, and the significant digits of the baseRangeable datatype.

Author:
dprenzel

Member Function Documentation

float de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.getAccuracy (  )  [package]

Returns the value of the 'Accuracy' attribute.

accuracy : Float [1]
The accuracy of the data (e.g., the FunctionFlowports input or output).
Example: An accuracy of 0.5 of the temperature means a communicated value of 19 represents an actual temperature of 19 +/- 0.5 degrees.

Returns:
the value of the 'Accuracy' attribute.
See also:
setAccuracy(float)
de.fraunhofer.isst.eastadl.datatypes.DatatypesPackage.getRangeableValueType_Accuracy() required="true"

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

RangeableDatatype de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.getBaseRangeable (  ) 

Returns the value of the 'Base Rangeable' reference.

baseRangeable : RangeableDatatype [1]
The RangeableDatatype that the RangeableValueType points to.

Returns:
the value of the 'Base Rangeable' reference.
See also:
setBaseRangeable(RangeableDatatype)
de.fraunhofer.isst.eastadl.datatypes.DatatypesPackage.getRangeableValueType_BaseRangeable() required="true"

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

float de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.getResolution (  ) 

Returns the value of the 'Resolution' attribute.

resolution : Float [1]
The resolution of the data expressed as the size of the minimum difference between data values.
Example: A resolution of 0.1 means that temperature may be represented in increments of 0.1 degrees.

Returns:
the value of the 'Resolution' attribute.
See also:
setResolution(float)
de.fraunhofer.isst.eastadl.datatypes.DatatypesPackage.getRangeableValueType_Resolution() required="true"

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

int de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.getSignificantDigits (  ) 

Returns the value of the 'Significant Digits' attribute.

significantDigits : int [0..1]
The number of significant digits, e.g., for the speed case: if the speed is a one digit number (e.g., 5 km/h), then this digit is significant, if the speed is a two digits number (e.g., 15 km/h), then the first digit is significant (here: 1), if the speed is a three digits number (e.g., 215 km/h), then the first two digits are significant (here: 21). Significant means here, that the respective digits are reliable.

Returns:
the value of the 'Significant Digits' attribute.
See also:
isSetSignificantDigits()
unsetSignificantDigits()
setSignificantDigits(int)
de.fraunhofer.isst.eastadl.datatypes.DatatypesPackage.getRangeableValueType_SignificantDigits() unsettable="true"

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

boolean de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.isSetSignificantDigits (  ) 

Returns whether the value of the 'Significant Digits' attribute is set.

significantDigits : int [0..1]
The number of significant digits, e.g., for the speed case: if the speed is a one digit number (e.g., 5 km/h), then this digit is significant, if the speed is a two digits number (e.g., 15 km/h), then the first digit is significant (here: 1), if the speed is a three digits number (e.g., 215 km/h), then the first two digits are significant (here: 21). Significant means here, that the respective digits are reliable.

Returns:
whether the value of the 'Significant Digits' attribute is set.
See also:
unsetSignificantDigits()
getSignificantDigits()
setSignificantDigits(int)

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

void de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.setAccuracy ( float  value  ) 

Sets the value of the 'Accuracy' attribute.

accuracy : Float [1]
The accuracy of the data (e.g., the FunctionFlowports input or output).
Example: An accuracy of 0.5 of the temperature means a communicated value of 19 represents an actual temperature of 19 +/- 0.5 degrees.

Parameters:
value the new value of the 'Accuracy' attribute.
See also:
getAccuracy()

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

void de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.setBaseRangeable ( RangeableDatatype  value  ) 

Sets the value of the 'Base Rangeable' reference.

baseRangeable : RangeableDatatype [1]
The RangeableDatatype that the RangeableValueType points to.

Parameters:
value the new value of the 'Base Rangeable' reference.
See also:
getBaseRangeable()

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

void de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.setResolution ( float  value  ) 

Sets the value of the 'Resolution' attribute.

resolution : Float [1]
The resolution of the data expressed as the size of the minimum difference between data values.
Example: A resolution of 0.1 means that temperature may be represented in increments of 0.1 degrees.

Parameters:
value the new value of the 'Resolution' attribute.
See also:
getResolution()

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

void de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.setSignificantDigits ( int  value  ) 

Sets the value of the 'Significant Digits' attribute.

significantDigits : int [0..1]
The number of significant digits, e.g., for the speed case: if the speed is a one digit number (e.g., 5 km/h), then this digit is significant, if the speed is a two digits number (e.g., 15 km/h), then the first digit is significant (here: 1), if the speed is a three digits number (e.g., 215 km/h), then the first two digits are significant (here: 21). Significant means here, that the respective digits are reliable.

Parameters:
value the new value of the 'Significant Digits' attribute.
See also:
isSetSignificantDigits()
unsetSignificantDigits()
getSignificantDigits()

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.

void de.fraunhofer.isst.eastadl.datatypes.RangeableValueType.unsetSignificantDigits (  ) 

Unsets the value of the 'Significant Digits' attribute.

significantDigits : int [0..1]
The number of significant digits, e.g., for the speed case: if the speed is a one digit number (e.g., 5 km/h), then this digit is significant, if the speed is a two digits number (e.g., 15 km/h), then the first digit is significant (here: 1), if the speed is a three digits number (e.g., 215 km/h), then the first two digits are significant (here: 21). Significant means here, that the respective digits are reliable.

See also:
isSetSignificantDigits()
getSignificantDigits()
setSignificantDigits(int)

Implemented in de.fraunhofer.isst.eastadl.datatypes.impl.RangeableValueTypeImpl.