Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: MEASURE Object
MEASURE Object
Members
Name
Type
Purpose
Constructors
Measure ()
MEASURE
Creates an invalid/unset dimension (INVALID).
Measure(STRING)
MEASURE
Creates a MEASURE of which string is a 'reasonable' match to any of description, name, hashcode, format code (L, L2 etc) or any other recognisable name or abbreviation of a unit of the measure.
Measure(REAL)
MEASURE
Creates a MEASURE of which the value of REAL is a (valid) enum value, or is a negative (non standard) dimension..
Methods
Name
Result
Purpose
Description()
String()
STRING
Long description of dimension.
Name()
STRING
Unique name used for format statements and commands
Hashcode()
Ptype()
STRING
Hash code of dimension. Returns 'GENERIC' if generic dimension - i.e. non standard.
Current Unit Methods
currentunits()
UNIT
Returns current unit of this dimension.
UnitQualifier()
STRING
Unit qualifier of current units.
UnitFactor()
REAL
Conversion factor to database units from current units.
SetUnits(unit)
BOOLEAN
Returns true if successfully set current unit of the dimension to unit.
Numeric()
BOOLEAN
Sets current units of dimension to be Numeric (i.e. no unit conversion in place).
NUMERIC units have Hashcode NUMB and null names, unitqualifiers, and descriptions.
Returns true if successful.
Default()
BOOLEAN
Sets current units of all dimensions to those defined by catalogue BUNI/DUNI.
Returns true if successful.
Suspend()
BOOLEAN
Suspends current units of all physical quantities and operates exclusively in database units. Pushes up one level of suspension.
Returns true if successful.
SuspendLevel()
REAL
Returns number of levels of suspension of current units. If 0 no suspension in force.
Reinstate()
BOOLEAN
Reinstates currently defined current working units for all quantities. Clears suspension stack.
Returns true if successful.
Unsuspend()
BOOLEAN
Pops one level of suspension stack of current units. If level now one working in defined current units.
Returns true if successful.
General Queries
IsNull()
BOOLEAN
TRUE if dimension is NONE.
IsStandard()
BOOLEAN
TRUE if dimension is a named (standard) dimension.
FALSE if specified from powers of its base components (i.e. Generic).
DBUnits()
DBUnit()
UNIT
Database unit for this dimension.
UnitsOf()
ARRAY of UNITs
Set of standard units of this dimension.
AllDimensions()
ARRAY of MEASUREs
Set of all standard dimensions.
AllUnits()
ARRAY of UNITs
Set of all named Units
Enum()
REAL
Unique integer ID for this Dimension.
Positive if standard dimension (packed Hash Value)
Negative if generic dimension coded from component base dimensions.
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.