Measure Reference Manual

MEASCONTROL
Starts and stops a measurement, including a measurement interval as an option.
Before calling MEASCONTROL, your program must call MEASCONFIGURE and configure the
measurement.
error := MEASCONTROL ( meascb ! i,o
,measnum ! i
,[ starttime ] ! i
,[ stoptime ] ! i
,[ interval ] ); ! i
meascb
input, output
INT:ref:$LEN(MEASCB^DEF) / 2
is a control block where the Measure subsystem stores data for subsequent procedure calls.
Before calling the first Measure procedure that uses meascb, you must allocate space in your
global data area for the control block and initialize each element of the control block to -1.
After you pass meascb to a Measure procedure, do not modify its contents.
The file $SYSTEM.SYSnn.MEASDECS contains the structure definition for the control block
descriptor (MEASCB^DEF).
measnum
input
INT:value
is the measurement number. Use the measnum value returned by the MEASCONFIGURE
procedure.
starttime
input
FIXED:value
is the start time of the measurement. If you omit it or specify it as -1, the measurement is
configured but not started. If you specify starttime and stoptime, starttime must be
less than stoptime. Specify starttime as a Julian date based on local civil time (LCT) in
four-word-by-one-microsecond format as provided by the system procedure JULIANTIMESTAMP.
See the Guardian Procedure Calls Reference Manual.
stoptime
input
FIXED:value
is the stop time of the measurement. If you omit it or specify it as -1, the measurement runs until
a stop time is supplied by a subsequent call. If you specify starttime and stoptime,
starttime must be less than stoptime. Specify stoptime as a Julian date based on LCT
in four-word-by-one-microsecond format as provided by the system procedure
JULIANTIMESTAMP. See the Guardian Procedure Calls Reference Manual.
interval
input
FIXED:value
is the collection interval. Counter values are written to the data file at the specified time intervals,
when a transient entity starts or when a transient entity stops. If you omit interval, counter
values are written to the data file twice: once at the beginning of the measurement and once
at the end. Specify interval in microseconds. You cannot change the collection interval after
starting the measurement.
386 Measure Callable Procedures