SLAC ESD Software Engineering
Group
| AIDA |
SLC Multiknob 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 Multiknob Data Provider. This data provider allows the setting of devices referenced in a specified multiknob file by knob rotation using a specified relative delta value. Only a relative (not absolute) multiknob file may be specified.
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 Multiknob 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 Multiknob
|
SUMMARY
|
|||||
|
Supports a set operation to set the devices
referenced in a specified multiknob file by knob rotation using a
specified delta value. Only a relative (not absolute) mulitknob
file may be specified. The set operation returns the name of each
device in the specified multiknob file and the device value after
the operation.
|
|||||
| 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 more multiknob examples.
String query = "MKB//VAL";
da.setParam("MKB", "mkb:li02b_xb.mkb"); /* Required MKB parameter specifying a multiknob file. */
Float relativeDelta = new Float(1.0f); /* Specified relative delta knob rotation. */
DaValue inData = new DaValue(relativeDelta); /* Creation of DaValue to hold relative delta value. */
DaValue outData = da.setDaValue(query, inData); /* Perform set operation for multiknob file knob rotation. */
|
||||
| Java | $CD_SOFT/ref/package/aida/test/java/DpSlcUtilTests.java | ||||
| Matlab | $CD_SOFT/ref/package/aida/test/matlab/multiknobDemo.m | ||||
|
INSTANCES
|
||||||
| Types | Description | |||||
| Multiknob Request | Syntax | MKB//VAL | ||||
| Example | MKB//VAL | |||||
|
Instance Attributes
|
||||||
| Attribute | Description | |||||
| VAL | Sets devices referenced in a specified multiknob file, which is a required parameter. The parameter data argument (p) is a DaValue containing a Float value specifying the relative delta knob rotation value. | |||||
| Methods | Name* | Returns | ||||
| setDaValue(q, p) | Returns a DaValue
containing a heterogenous vector of 2 homogenous congruent vectors:
|
|||||
| Parameters | Name |
Req/ |
Syntax | Semantics | ||
| MKB |
req |
multiknob filename |
The filename path specification (including the prefix "mkb:", if file is in the standard multiknob file directory) of a multiknob file. | |||
* See DaObject and DaReference (and DaReference's parent _DaReference) in aida.lib.da for full API and method signatures.
The SLC Multiknob 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