man1/AutoWait3

Table of Contents

Name

AutoWait3 - wait for a parameter to achieve a value

Synopsis

AutoWait3 <argument list>

Description

This program subscribes to the datapoint indicated by label-refname pair.

It processes messages from dbman until the datapoint reaches the condition specified by the type and value arguments or until tmo seconds is reached.

See the Comparison Types section below for more information.

Arguments

Argument processing done using long option syntax.

Arguments marked optional are not required.

--dbman_host <hn>

Optional. The host where dbman is running. This defaults to localhost or the DBMAN_HOST envorinonment variable if not supplied.
--tagname <label>|<refname>

An AccelNET Label-RefName pair.
--type <comparison>

The type of comparison to perform. See below for a further description of available types.
--state <value>

The comparion value.
--timeout <seconds>

The number of seconds to wait until exiting if there isn’t a match.
--window <value>

Optional. The window value for use with the win type. If not supplied it defaults to 0.1
--verbose

Sets the loquacity of the program. This has an optional modifier to increase the amount of output. for example --verbose=2 will provide lots of output where available, while --verbose will provide basic information.
--help

Prints out a help message to stderr.

Return Codes


0 is returned if datapoint reached the desired value.
1 is returned if datapoint never reached the desired value.
2 I/O or other failure.

Comparison Types

db_value is the value from the database.
eq

if (db_value == value) done
lt

if (db_value <= value) done
gt

if (db_value >= value) done
win

if (abs(db_value) <= value) done

Examples


#
# check for cathode number equal to 12.
# use a 100 second timeout
AutoWait3 --tagname "MCS S1-1|CatNumR" --state 12 --type eq --timeout 100

Manual page revision

$Id: AutoWait3.1,v 1.2 2007/08/17 20:44:44 mcnamer Exp $

Table of Contents