EPICS_base/pvaClient
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Update version numbers and formatting in documentation

Browse Source
This commit is contained in:
Andrew Johnson
2018-12-17 16:17:52 -06:00
parent 8ab4dd1fdb
commit b1c101578b
2 changed files with 26 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
documentation/RELEASE_NOTES.md
View File

@ -1,29 +1,30 @@
EPICS 7 release 4.7.1
=====================
# pvaClientCPP Module
API changes to PvaClientMonitor
-------------------------------
This document summarizes the changes to the module between releases.
## Release 4.4 (EPICS 7.0.2, Dec 2018)
### API changes to PvaClientMonitor
The create method that had arguments for stateChangeRequester and monitorRequester no longer exists.
API changes to PvaClientGet, ..., PvaClientMonitor
--------------------------------------------------
### API changes to PvaClientGet, ..., PvaClientMonitor
pvaClientGet, ..., pvaClientMonitor all implemented PvaClientChannelStateChangeRequester.
This was never called and has been removed.
Previously the pvaClientGet, ..., pvaClientMonitor classes all implemented PvaClientChannelStateChangeRequester(). This method was never called and has been removed.
Works with pvDataCPP-7.0 and pvAccessCPP-6.0 versions
-----------------------------------------------------
Will not work with older versions of these modules.
## Release 4.3 (EPICS 7.0.1, Dec 2017)
destroy methods removed
-----------------------
### Requires pvDataCPP-7.0 and pvAccessCPP-6.0 versions
All the destroy methods are removed since implementation is RAII compliant.
This release will not work with older versions of these modules.
API changes to PvaClientMonitor
-------------------------------
### Destroy methods removed
All the destroy() methods have been removed, implementation is RAII compliant.
### API changes to PvaClientMonitor
The second argument of method
@ -33,7 +34,7 @@ The second argument of method
epics::pvData::PVStructurePtr const &pvRequest
);
Is now changed to
is now changed to
static PvaClientMonitorPtr create(
PvaClientPtr const &pvaClient,
@ -53,22 +54,16 @@ A new method is also implemented
);
pvaClientCPP Version 4.2
========================
## Release 4.2 (EPICS V4.6, Aug 2016)
* The examples are moved to exampleCPP.
* Support for channelRPC is now available.
* In PvaClientMultiChannel checkConnected() now throws an exception if connect fails.
pvaClientCPP Version 4.1
========================
## Release 4.1 (EPICS V4.5, Oct 2015)
pvaClient is a synchronous API for pvAccess.
This is the first release of pvaClientCPP.
It provides an API that is similar to pvaClientJava.

12
documentation/pvaClientCPP.html
View File

@ -26,13 +26,13 @@
<div class="head">
<h1>EPICS pvaClientCPP</h1>
<h2 class="nocount">Release 4.3.0 - 2017-12-14</h2>
<h2 class="nocount">Release 4.4 - December 2018</h2>
<h2 class="nocount">Abstract</h2>
<p>pvaClient is a software library that provides, to an EPICS client programmer, a friendly
client side programming interface to the data of an EPICS based control system. It is intended
for such uses as rapid development of ad hoc programs by controls engineers, or to provide
client side programming interface to the data of an EPICS based control system. It is intended
for such uses as rapid development of ad hoc programs by controls engineers, or to provide
scientists a way to directly develop analytical applications.</p>
<p>Specifically, pvaClient provides a synchronous interface for pvAccess, which is the
@ -41,7 +41,7 @@ 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
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.
</p>
@ -62,11 +62,11 @@ The data for the channels is presented via normative type NTMultiChannel.
</div> <!-- head -->
<div id="contents" class="contents">
<div id="contents" class="contents">
<hr />
<h2>Overview</h2>
<p>
pvaClientCPP is one of the components of
pvaClientCPP is one of the components of
<a href="http://epics-pvdata.sourceforge.net">
EPICS Version 4
</a>