Update and unify README.md

This commit is contained in:
Andrew Johnson
2018-12-17 16:24:28 -06:00
parent d508792f2a
commit 761c62050d

View File

@ -1,38 +1,21 @@
pvaDatabaseCPP
============
# pvDatabaseCPP
The EPICS **pvDatabase** module provides a set of network accessible, smart, memory resident records with a C++ API. Each record has data composed of a top level PVStructure. Each record has a name which is the channelName for pvAccess. A local Channel Provider implements the complete ChannelProvider and Channel interfaces as defined by pvAccess. The local provider gives access to the records in the pvDatabase. This local provider is accessed by the remote pvAccess server. A record is smart because code can be attached to a record, which is accessed via a method named process.
A brief description of a pvDatabase is that it is a set of network accessible, smart, memory resident records. Each record has data composed of a top level PVStructure. Each record has a name which is the channelName for pvAccess. A local Channel Provider implements the complete ChannelProvider and Channel interfaces as defined by pvAccess. The local provider provides access to the records in the pvDatabase. This local provider is accessed by the remote pvAccess server. A record is smart because code can be attached to a record, which is accessed via a method named process.
pvaDatabase is a synchronous Database interface to pvAccess,
which is callback based.
pvaDatabase is thus easier to use than pvAccess itself.
The pvDatabase module implements a synchronous C++ server interface to pvAccessCPP that was designed to be easier to use than the basic pvAccess server API.
See documentation/pvaDatabaseCPP.html for details.
## Links
Building
--------
- General information about EPICS can be found at the
[EPICS Controls website](https://epics-controls.org).
- API documentation for this module can be found in its
documentation directory, in particular the file
pvDatabaseCPP.html
If a proper RELEASE.local file exists one directory level above pvaDatabaseCPP
then just type:
## Building
make
It can also be built by:
cp configure/ExampleRELEASE.local configure/RELEASE.local
edit configure/RELEASE.local
make
Examples
------------
Examples are available in exampleCPP.
Status
------
* The API is for EPICS Version 4 release 4.6.0
This module is included as a submodule of a full EPICS 7 release and will be compiled during builds of that software.
## Examples
Some examples are available in the separate exampleCPP module.