Algorithm[:explicit][:state, Parameters, Comments – VXI VT1422A User Manual

Page 249

Advertising
background image

VT1422A Command Reference 247

Chapter 7

ALGorithm

Note

If <alg_name> specifies an undefined algorithm, ALG:SIZE? returns 0. This can be
used to determine whether algorithm <alg_name> is defined.

Returned Value: numeric value up to the maximum available algorithm

memory (this approximately 40k words). The type is int32.

*RST Condition: returned value is 0.

Send with VXIplug&play Function: hpe1422_cmdInt32_Q(...)

ALGorithm[:EXPLicit][:STATe]

ALGorithm[:EXPLicit][:STATe] ’<alg_name>’,<enable>

specifies that algorithm

<alg_name>, when defined, should be executed (ON) or not executed (OFF) during
run-time.

Notes

1. The command ALG:STATE <alg_name>, ON | OFF does not take effect until

an ALG:UPDATE or ALG:UPD:CHAN command is received. This allows
multiple ALG:STATE commands to be sent with a synchronized effect.

2. ALG:STATE places a variable update request in the Update Queue. Do not

place more update requests in the Update Queue than are allowed by the
current setting of ALG:UPD:WINDOW or a "Too many updates – send
ALG:UPDATE command" error message will be generated.

CAUTION

When ALG:STATE OFF disables an algorithm, its control output is left
at the last value set by the algorithm. Depending on the process, this
uncontrolled situation could be dangerous. Make certain that the
process is in a safe state before halting the execution of a controlling
algorithm.

Parameters

Comments

The algorithm specified by <alg_name> may or may not be currently defined.

The setting specified will be used when the algorithm is defined.

*RST Condition: ALG:STATE ON

Parameter

Name

Parameter

Type

Range of

Values

Default

Units

alg_name

string

ALG1 - ALG32

none

enable

boolean (uint16)

0 | 1 | ON | OFF

none

Advertising
This manual is related to the following products: