updated documentation
This commit is contained in:
@@ -28,7 +28,7 @@
|
||||
<h1>EPICS pvaClientCPP</h1>
|
||||
<!-- Maturity: Working Draft or Request for Comments, or Recommendation, and date. -->
|
||||
<h2 class="nocount">EPICS V4 Working Group, Working Draft,
|
||||
26-June-2015</h2>
|
||||
03-August-2015</h2>
|
||||
<dl>
|
||||
<dt>This version:</dt>
|
||||
<dd><a
|
||||
@@ -36,12 +36,12 @@
|
||||
</a> </dd>
|
||||
<dt>Latest version:</dt>
|
||||
<dd><a
|
||||
href="pvaClientCPP_20150626.html">pvaClientCPP_20150626.html
|
||||
href="pvaClientCPP_20150803.html">pvaClientCPP_20150803.html
|
||||
</a> </dd>
|
||||
<dt>Previous version:</dt>
|
||||
<dd><a
|
||||
href="easyPVA_20150609.html">easyPVA_20150609.html</a>
|
||||
</dd>
|
||||
href="pvaClientCPP_20150626.html">pvaClientCPP_20150626.html
|
||||
</a> </dd>
|
||||
<dt>Editors:</dt>
|
||||
<dd>Marty Kraimer, BNL</dd>
|
||||
</dl>
|
||||
@@ -58,6 +58,7 @@ software support for high speed controls network communications used in EPICS ve
|
||||
pvAccess provides a callback based interface, which can be hard to use.
|
||||
pvaClient provides an interface that does not require callbacks even for monitors.
|
||||
</p>
|
||||
<p>
|
||||
pvaClientChannel provides many "convenience" methods to directly get and put
|
||||
scalar and scalarArray data types.
|
||||
Additional methods provide access to the full features of pvAccess.
|
||||
@@ -111,26 +112,13 @@ href="./html/index.html">doxygenDoc
|
||||
</a>
|
||||
</p>
|
||||
<h2>Example Database</h2>
|
||||
<p>The examples require that an example pvAccess server is runnimg.
|
||||
To get the test database go to:</p>
|
||||
<a
|
||||
href="https://github.com/epics_base/pvaClientTestCPP/blob/master/database.zip">pvaClientTestCPP/database.zip
|
||||
</a>
|
||||
Then select "raw file" and You will be able to download the zip file.
|
||||
<p>
|
||||
When unzipped this is used to create an example IOC database.
|
||||
</p>
|
||||
<p>
|
||||
After unzipping the file:
|
||||
</p>
|
||||
<p>The examples require that the database provided by project pvaClientTestCPP
|
||||
is running.
|
||||
For example:</p>
|
||||
<pre>
|
||||
cd database/configure
|
||||
cp ExampleRELEASE.local RELEASE.local
|
||||
edit RELEASE.local
|
||||
cd ..
|
||||
make
|
||||
cd iocBoot/exampleDatabase
|
||||
../../bin/<arch:>/exampleDatabase st.cmd
|
||||
mrk> pwd
|
||||
/home/epicsv4/pvaClientTestCPP/database/iocBoot/exampleDatabase
|
||||
mrk> ../../bin/linux-x86_64/exampleDatabase st.cmd
|
||||
</pre>
|
||||
<h2>Examples</h2>
|
||||
<p>Examples are in directory <b>example/src</b>.
|
||||
@@ -172,24 +160,19 @@ helps to also look at the source for the example.</p>
|
||||
</dl>
|
||||
<h2>examplePvaClientMonitor</h2>
|
||||
<p>This is an example of creating a monitor on a channel.
|
||||
It monitors a channel that models a powerSupply, i. e. it is not a "standard" record.
|
||||
It does not have a value field.
|
||||
It monitors a scalar double field.
|
||||
It also issues puts to the same channel so that it can make the monitors occur.
|
||||
</p>
|
||||
<p>After starting the example a change can be made to the powerSupply by issuing:</p>
|
||||
<pre>
|
||||
pvput -r "power.value,voltage.value" examplePowerSupply 6 6
|
||||
</pre>
|
||||
<h2>examplePvaClientPut</h2>
|
||||
<p>This example gets and puts to channel exampleDouble.</p>
|
||||
<p>This example gets and puts to channels exampleDouble
|
||||
and exampleDoubleArray.</p>
|
||||
<h2>examplePvaClientProcess</h2>
|
||||
<p>This example makes a process request to channel exampleDouble.</p>
|
||||
<h2>helloWorldPutGet</h2>
|
||||
<p>This is an example of issuing a channelPutGet.</p>
|
||||
<h2>examplePvaClientMultiDouble</h2>
|
||||
<p>This is an example of issuing gets and puts to multiple channels where each
|
||||
channel has a numeric scalar value field.</p>
|
||||
<h2>examplePvaClientNTMultiChannel</h2>
|
||||
<p>This is an example of using NDMultiChannel to obtain data from multiple channels.
|
||||
<p>This is an example of using pvaClientMultiChannel,
|
||||
pvaClientMultiGetDouble, pvaClientMultiPutDouble, and pvaClientMultiMonitorDouble.
|
||||
</p>
|
||||
<h2>helloWorldRPC</h2>
|
||||
<p>This is an example of issuing a channelRPC request.
|
||||
|
||||
@@ -297,23 +297,15 @@ It has methods:</p>
|
||||
<h2>PvaClientMultiChannel - Wrapper For Multiple Channels</h2>
|
||||
<h3>PvaClientMultiChannel</h3>
|
||||
<p>This provides methods for connecting to multiple channels.
|
||||
A client can either use PvaClientMultiChannel directly or use PvaClientMultiDouble or PvaClientNTMultiChannel.
|
||||
But both impose restrictions on what can be accessed.
|
||||
</p>
|
||||
<h3>PvaClientMultiDouble</h3>
|
||||
<p>This provides support for gets and puts to the value field of multiple channels.
|
||||
Each channel must have a value field that is a numeric scalar.
|
||||
The client always sees the data as a PVDoubleArray.
|
||||
All channels must connect.
|
||||
If any problems occur an exception is thrown.
|
||||
<h3>PvaClientMultiGetDouble</h3>
|
||||
<p>This provides support for channelGet to multiple channels.
|
||||
</p>
|
||||
<h3>PvaClientNTMultiChannel</h3>
|
||||
<p>This provides support for gets and puts to the value field of multiple channels.
|
||||
Each channel must have a value field.
|
||||
The client always sees the data as a NTMultiChannel, which is one
|
||||
of the types provided by normativeTypesCPP.
|
||||
All channels must connect.
|
||||
If any problems occur an exception is thrown.
|
||||
<h3>PvaClientMultiPutDouble</h3>
|
||||
<p>This provides support for channelPut to multiple channels.
|
||||
</p>
|
||||
<h3>PvaClientMultiMonitorDouble</h3>
|
||||
<p>This provides support for monitoring changes to multiple channels.
|
||||
</p>
|
||||
|
||||
</div> <!-- class="contents" -->
|
||||
|
||||
Reference in New Issue
Block a user