Scripting > Math Functions


Determine if Data is in Metric Units

isMetric()

 

Determine if the current time series or paired data set is in Metric (SI) units.  The function examines the data set parameter type and units label to establish the unit system.

 

See also: isEnglish(); convertToMetricUnits()

Parameters: Takes no parameters

Example: if dataSet.isMetric() : print “SI Units”

Returns: Constants.TRUE if the data set units are Metric, otherwise Constants.FALSE.

Generated Exceptions: Throws a hec.hecmath.HecMathException if the unit system cannot be determined (parameter type and units label undefined).