SLAC ESD Software Engineering
Group
| AIDA |
SLC BGRP Set Variable Data Provider Guide |
| SLAC Detailed |
| SLAC Computing |
| Software Home |
| Software Detailed |
| AIDA |
| SLC Peer PG |
|
SLAC ESD Software Engineering
Group
|
|||||||||||
|
|
|
|
|||||||||
This page provides documentation for users and programmers of AIDA's SLC BGRP Set Variable Data Provider. This data provider allows for the setting of a BGRP variable value.
See Also: Basic Users Guide to Aida, REF_AIDASHR; AIDA SLC Peer Programmers Guide
This section describes what an AIDA user should know about using the SLC BGRP Set Variable data provider.For general information on using see Basic Users Guide to Aida, and the Aida javadoc, in particular the classes DaObject and DaReference (and DaReference's parent _DaReference) in aida.lib.da which form Aida's programming interface. One can also use Matlab.
Table 1: Summary of AIDA Data Provider for SLC Set Variable
|
SUMMARY
|
|||||
|
Supports a set operation to set the value
of a specified variable for a specified BGRP.
|
|||||
| Status and limitations | The data provider is complete and there are no known limitations. | ||||
| Plan | No active plans for extensions. | ||||
|
EXAMPLES
|
|||||
| Schematic | Java example. See DpSlcUtilTests.java for two BGRP set variable examples.
String query = "BGRP//VAL";
da.setParam("BGRP", "LCLS"); /* Required BGRP parameter specifying a BGRP name. */
da.setParam("VARNAME", "T_CAV"); /* Required VARNAME parameter specifying a variable name for the BGRP. */
String setValue = "Y"; /* New BGRP variable value ("N" or "Y"). */
DaValue inData = new DaValue(setValue); /* Creation of DaValue to hold new BGRP variable set value. */
da.setDaValue(query, inData); /* Perform BGRP varaible set value operation. */
|
||||
| Java | $CD_SOFT/ref/package/aida/test/java/DpSlcUtilTests.java | ||||
| Matlab | $CD_SOFT/ref/package/aida/test/matlab/bgrpDemo.m | ||||
|
INSTANCES
|
||||||
| Types | Description | |||||
| BGRP Set Variable Request | Syntax | BGRP//VAL | ||||
| Example | BGRP//VAL | |||||
|
Instance Attributes
|
||||||
| Attribute | Description | |||||
| VAL | Sets a BGRP variable to a new value. The parameter data argument (p) is a DaValue containing a String specifying the new variable value ("N" or "Y"). | |||||
| Methods | Name* | Returns | ||||
| setDaValue(q, p) | Does not return a value. | |||||
| Parameters | Name |
Req/ |
Syntax | Semantics | ||
| BGRP |
req |
String |
The BGRP name. | |||
| VARNAME |
req |
String |
A BGRP variable name for the specified BGRP. | |||
* See DaObject and DaReference (and DaReference's parent _DaReference) in aida.lib.da for full API and method signatures.
The SLC BGRP Set Variable Data Provider is a provider in the AIDA SLC Peer (along with others such as the SLC DB Data Provider, the SLC History Data Provider, the SLC Model Data Provider, the SLC BPM Data Provider, the SLC Magnet Data Provider, the SLC Master Oscillator Data Provider, and the SLC Klystron Data Provider). Development of all these data providers is described in a Programmers Guide here.
Author: Bob Hall 12-Dec-2006