From 2fae1da00a658b2133ff3d405bbbe9600fad8258 Mon Sep 17 00:00:00 2001 From: mrkraimer Date: Tue, 4 Aug 2015 07:19:35 -0400 Subject: [PATCH] cleanup documentation --- documentation/easyPVA_20150609.html | 222 ------------------ ...150325.html => pvaClientCPP_20150803.html} | 123 ++++------ 2 files changed, 44 insertions(+), 301 deletions(-) delete mode 100644 documentation/easyPVA_20150609.html rename documentation/{easyPVA_20150325.html => pvaClientCPP_20150803.html} (58%) diff --git a/documentation/easyPVA_20150609.html b/documentation/easyPVA_20150609.html deleted file mode 100644 index dec0657..0000000 --- a/documentation/easyPVA_20150609.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - EPICS easyPVA - - - - - - - - - - - -
-

EPICS easyPVA

- -

EPICS V4 Working Group, Working Draft, -25-Mar-2015

-
-
This version:
-
easyPVA.html -
-
Latest version:
-
easyPVA_20150609.html -
-
Previous version:
-
easyPVA_20150325.html -
-
Editors:
-
Marty Kraimer, BNL
-
Matej Sekoranja, Cosylab
-
- -

Abstract

-

NO LONGER SUPPPORTED: -The functionality has been moved to pvAccessCPP and EasyPva renamed to Pva. -

- -

EasyPVA (Easy PVAccess) 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 -scientists a way to directly develop analytical applications.

- -

Specifically, easyPVA provides an easy interface for pvAccess, which is the -software support for high speed controls network communications used in EPICS version 4. -PvAccess provides a callback based interface, which can be hard to use. -EasyPVA provides an interface that does not require callbacks even for monitors. -

-

-EasyChannel provides many "convenience" methods to directly get and put -scalar and scalarArray data types. -Additional methods provide access to the full features of pvAccess. -

-

-EasyMultiChannel provides access to data from multiple channels. -It can be used directly by a client or via EasyMultiDouble or EasyNTMultiChannel. -EasyMultiDouble allows the client to get and put data to multiple channels. -But each channel must have a value field that is a numeric scalar. -EasyNTMultiChannel allows the client to get and put data to multiple channels. -Each channel must have a value field. -The data for the channels is presented via normative type NTMultiChannel. -

- -

For more information about EPICS generally, please refer to the home page of the Experimental Physics and Industrial - Control System.

- - - -

Status of this Document and of the EasyPVA Software

- -

EasyPVACPP is ready for use.

- -
- -
-

Table of Contents

-
- - -
-
- -

Introduction

- -

EasyPVA is a synchronous API for accessing PVData via PVAccess. It provides -an interface to many of the features provided by pvData and pvAccess.

- -

This document describes the layout of the source files in this project.

-

-A user overview is available via -overview.html - -

-

-Doxygen documentation is available at -doxygenDoc - -

-

Building

-

After obtaining the source:

-
-cd configure
-cp ExampleRELEASE.local RELEASE.local
-
-

Edit RELEASE.local so that all path names are correct for you environment. -

-

-Then:

-
-cd ..
-make
-
- -

Example and Test Database

-

The examples and tests require that an example pvAccess server is runnimg. -This distribution has a file exampleDatabaseEasyPVA.zip. -When unzipped this is used to create an example IOC database. -The database has the record used by the examples are tests that come with easyPVAJava. -It uses pvDatabaseCPP to build the database. -

-

-After unzipping the file: -

-
-cd configure
-cp ExampleRELEASE.local RELEASE.local
-edit RELEASE.local
-cd ..
-make
-cd iocBoot/exampleDatabase
-../../bin/<arch:>/exampleDatabase st.cmd
-
-

Testing

-

The tests will fail unless the example database is running.

-

Once it is running:

-
-make runtests
-
-

Examples

-

Examples are in directory example/src. -An example of how to run them is:

-
-mrk> pwd
-/home/hg/easyPVACPP/example
-mrk> bin/linux-x86_64/exampleEasyGet 
-
-

The following is a brief description of each example. -In order to understand each example it -helps to also bee loooking at the source for the example.

-

exampleEasyGet

-

This has a number of examples:

-
-
exampleDouble
-
- This shows two methods for getting data from a channel that has a numeric - scalar value field. -
-
exampleDoubleArray
-
- This shows two methods for getting data from a channel that has a - double array value field. -
-
exampleCADouble
-
- This is like exampleDouble except it uses provider ca. -
-
exampleCADoubleArray
-
- This is like exampleDoubleArray except it uses provider ca. -
-
examplePowerSupply
-
- This is an example of getting data from a channel that does not - have a value field. -
-
-

exampleEasyMonitor

-

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. -

-

After starting the example a change can be made to the powerSupply by issuing:

-
-pvput -r "power.value,voltage.value" examplePowerSupply 6 6
-
-

exampleEasyPut

-

This example gets and puts to channel exampleDouble.

-

exampleEasyProcess

-

This example makes a process request to channel exampleDouble.

-

helloWorldPutGet

-

This is an example of issuing a channelPutGet.

-

exampleEasyMultiDouble

-

This is an example of issuing gets and puts to multiple channels where each -channel has a numeric scalar value field.

-

exampleEasyNTMultiChannel

-

This is an example of using NDMultiChannel to obtain data from multiple channels. -

-

helloWorldRPC

-

This is an example of issuing a channelRPC request. -It does not use easyPVA.

-
- - diff --git a/documentation/easyPVA_20150325.html b/documentation/pvaClientCPP_20150803.html similarity index 58% rename from documentation/easyPVA_20150325.html rename to documentation/pvaClientCPP_20150803.html index 487937d..10eb3b5 100644 --- a/documentation/easyPVA_20150325.html +++ b/documentation/pvaClientCPP_20150803.html @@ -4,7 +4,7 @@ - EPICS easyPVA + EPICS pva
-

EPICS easyPVA

+

EPICS pvaClientCPP

EPICS V4 Working Group, Working Draft, -25-Mar-2015

+03-August-2015
This version:
easyPVA.html + href="pvaClientCPP.html">pvaClientCPP.html
Latest version:
easyPVA_20150325.html -
+ href="pvaClientCPP_20150803.html">pvaClientCPP_20150803.html +
Previous version:
-
none
+
pvaClientCPP_20150626.html +
Editors:
Marty Kraimer, BNL
-
Matej Sekoranja, Cosylab

Abstract

-

EasyPVA (Easy PVAccess) is a software library that provides to an EPICS client programmer, a friendly +

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 scientists a way to directly develop analytical applications.

-

Specifically, easyPVA provides an easy interface for pvAccess, which is the +

Specifically, pvaClient provides a synchronous interface for pvAccess, which is the software support for high speed controls network communications used in EPICS version 4. -PvAccess provides a callback based interface, which can be hard to use. -EasyPVA provides an interface that does not require callbacks even for monitors. +pvAccess provides a callback based interface, which can be hard to use. +pvaClient provides an interface that does not require callbacks even for monitors.

-EasyChannel 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.

-EasyMultiChannel provides access to data from multiple channels. -It can be used directly by a client or via EasyMultiDouble or EasyNTMultiChannel. -EasyMultiDouble allows the client to get and put data to multiple channels. +pvaClientMultiChannel provides access to data from multiple channels. +It can be used directly by a client or via pvaClientMultiDouble or pvaClientNTMultiChannel. +pvaClientMultiDouble allows the client to get and put data to multiple channels. But each channel must have a value field that is a numeric scalar. -EasyNTMultiChannel allows the client to get and put data to multiple channels. +pvaClientNTMultiChannel allows the client to get and put data to multiple channels. Each channel must have a value field. The data for the channels is presented via normative type NTMultiChannel.

@@ -78,9 +79,9 @@ The data for the channels is presented via normative type NTMultiChannel. -

Status of this Document and of the EasyPVA Software

+

Status of this Document and of the pvaClient Software

-

EasyPVACPP is ready for use.

+

pvaClientCPP is ready for use.

@@ -94,14 +95,14 @@ The data for the channels is presented via normative type NTMultiChannel.

Introduction

-

EasyPVA is a synchronous API for accessing PVData via PVAccess. It provides +

pvaClient is a synchronous API for accessing PVData via PVAccess. It provides an interface to many of the features provided by pvData and pvAccess.

This document describes the layout of the source files in this project.

A user overview is available via overview.html +href="./pvaClientOverview.html">pvaClientOverview.html

@@ -110,58 +111,27 @@ Doxygen documentation is available at href="./html/index.html">doxygenDoc

-

Building

-

After obtaining the source:

+

Example Database

+

The examples require that the database provided by project pvaClientTestCPP +is running. +For example:

-cd configure
-cp ExampleRELEASE.local RELEASE.local
-
-

Edit RELEASE.local so that all path names are correct for you environment. -

-

-Then:

-
-cd ..
-make
-
- -

Example and Test Database

-

The examples and tests require that an example pvAccess server is runnimg. -This distribution has a file exampleDatabaseEasyPVA.zip. -When unzipped this is used to create an example IOC database. -The database has the record used by the examples are tests that come with easyPVAJava. -It uses pvDatabaseCPP to build the database. -

-

-After unzipping the file: -

-
-cd configure
-cp ExampleRELEASE.local RELEASE.local
-edit RELEASE.local
-cd ..
-make
-cd iocBoot/exampleDatabase
-../../bin/<arch:>/exampleDatabase st.cmd
-
-

Testing

-

The tests will fail unless the example database is running.

-

Once it is running:

-
-make runtests
+mrk> pwd
+/home/epicsv4/pvaClientTestCPP/database/iocBoot/exampleDatabase
+mrk> ../../bin/linux-x86_64/exampleDatabase st.cmd

Examples

Examples are in directory example/src. An example of how to run them is:

 mrk> pwd
-/home/hg/easyPVACPP/example
-mrk> bin/linux-x86_64/exampleEasyGet 
+/home/epicsv4/pvaClientCPP/example
+mrk> bin/linux-x86_64/examplePvaClientGet

The following is a brief description of each example. In order to understand each example it -helps to also bee loooking at the source for the example.

-

exampleEasyGet

+helps to also look at the source for the example.

+

examplePvaClientGet

This has a number of examples:

exampleDouble
@@ -188,30 +158,25 @@ helps to also bee loooking at the source for the example.

have a value field.
-

exampleEasyMonitor

+

examplePvaClientMonitor

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.

-

After starting the example a change can be made to the powerSupply by issuing:

-
-pvput -r "power.value,voltage.value" examplePowerSupply 6 6
-
-

exampleEasyPut

-

This example gets and puts to channel exampleDouble.

-

exampleEasyProcess

+

examplePvaClientPut

+

This example gets and puts to channels exampleDouble +and exampleDoubleArray.

+

examplePvaClientProcess

This example makes a process request to channel exampleDouble.

helloWorldPutGet

This is an example of issuing a channelPutGet.

-

exampleEasyMultiDouble

-

This is an example of issuing gets and puts to multiple channels where each -channel has a numeric scalar value field.

-

exampleEasyNTMultiChannel

-

This is an example of using NDMultiChannel to obtain data from multiple channels. +

examplePvaClientMultiDouble

+

This is an example of using pvaClientMultiChannel, +pvaClientMultiGetDouble, pvaClientMultiPutDouble, and pvaClientMultiMonitorDouble.

helloWorldRPC

This is an example of issuing a channelRPC request. -It does not use easyPVA.

+It does not use pva.