HTGetValueAtScooter() Function

The HTGetValueAtScooter() function returns a value of the requested type for the sample at the specified scooter position, trend, and pen number. The UpdateCount argument causes the expression to be evaluated after function processing is finished.

Category

Historical

Syntax

RealResult=HTGetValueAtScooter(Hist_Tag, UpdateCount,ScootNum,ScootLoc,PenNum, ValType_Text);

Arguments

Hist_Tag

HistTrend tag assigned the name of the trend.

UpdateCount

Integer representing the trend's .UpdateCount dotfield.

ScootNum

Integer representing the left or right scooter:

1 = Left Scooter

2 = Right Scooter

ScootLoc

Real number representing the trend's .ScooterPosRight or .ScooterPosLeft dotfields.

PenNum

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

ValType_Text

String indicating the type of value to return:

PenValue = Value at scooter position.

PenValid = 0 if value is invalid, 1 if valid.

When the ValType_Text argument is used with the HTGetValueAtScooter() function, use one of the valid types listed.

Example

The following function returns a 1 if the value is an actual sample or a 0 if the value is invalid for pen 3 of the Trend1 trend for the right scooter's current position:

HTGetValueAtScooter("Trend1",Trend1.UpdateCount, 2,Trend1.ScooterPosRight,3, "PenValid");