beautypg.com

Control variables explained, Integer – Teledyne LeCroy WaveExpert series Automation Manual User Manual

Page 24

background image

A

BOUT

A

UTOMATION

CONTROL VARIABLES EXPLAINED

Traditionally, properties presented to an Automation Client are simple “variables” with types such as Integer (int),

String (BSTR), Floating Point (single, double), etc.
Control variables in X-Stream are an extension of the traditional Automation pattern, without affecting how they

appear to most Automation clients (see section below on early/late bound clients).
As an example of what this enables, consider the following:
Take a control such as VerScale (Volts/Div), this may be set and queried in Visual Basic as follows:

app.Acquisition.C1.VerScale = 0.5

CurrentValue = app.Acquisition.C1.VerScale

In addition, the following is supported:

minValue = app.Acquisition.C1.VerScale.GetMinValue

maxValue = app.Acquisition.C1.VerScale.GetMaxValue

This enables an Automation Client to not only set and query the current value of a control, but also to query its

limits. This is useful in the generation of instrument-independent applications, or applications that present scope

controls in a graphical user interface in which limits are required.
Various types of control variables are supported. The Type column in the X-Stream browser shows the control

type:

The type designations are also given in the reference section of this manual, and are defined as follows:

Integer

32-bit Integer Value

Double

Double-precision floating point value

DoubleLockstep

Double-precision floating point value locked to a non-

linear (e.g., 1, 2, 5) sequence.

Enum

List Value (e.g., “Orange,” “Apple,” “Pear”)

String

String value

Bool

Boolean Value { True, False }, { 0, -1 }

Action

Action (no arguments or value)

1-12

916435 RevA