HTGetValue() Function

The HTGetValue() function returns a value of the requested type for the trend's specified pen.

Category

Historical

Syntax

RealResult=HTGetValue(Hist_Tag,UpdateCount, PenNum,ValType_Text);

Arguments

Hist_Tag

HistTrend tag assigned the name of the trend.

UpdateCount

Integer representing the trend's .UpdateCount dotfield.

PenNum

Integer tag or value representing the pen number (1-8) of the trend.

ValType_Text

String indicating the type of value to return:

PenAverageValue = Average for the entire trend.

PenMaxValue = Maximum pen value for the entire trend.

PenMinValue = Minimum pen value for the entire trend.

PenMaxEU = Maximum engineering units value for the entire trend.

PenMinEU = Minimum engineering units value for the entire trend.

PenStdDev = Standard deviation for the entire trend.

Remarks

The function returns the requested value as a real value.

Example

The following statement obtains the standard deviation for the pen 2 data retrieved from the PumpPress trend. The value is stored in the LeftHemisphereSD memory real tag:

LeftHemisphereSD=HTGetValue("PumpPress", PumpPress.UpdateCount,2,"PenStdDev");