Converts NDArray callback data into EPICS V4 NTNDArray data and exposes it as an EPICS V4 PV
More...
#include <NDPluginPva.h>
Inheritance diagram for NDPluginPva:
Public Member Functions | |
| POINTER_DEFINITIONS (NDPluginPva) | |
| NDPluginPva (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, const char *pvName, int maxBuffers, size_t maxMemory, int priority, int stackSize) | |
| Constructor for NDPluginPva This plugin cannot block (ASYN_CANBLOCK=0) and is not multi-device (ASYN_MULTIDEVICE=0). More... | |
| void | processCallbacks (NDArray *pArray) |
| Callback function that is called by the NDArray driver with new NDArray data. More... | |
 Public Member Functions inherited from NDPluginDriver | |
| NDPluginDriver (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads, bool compressionAware=false) | |
| Constructor for NDPluginDriver; most parameters are simply passed to asynNDArrayDriver::asynNDArrayDriver. More... | |
| ~NDPluginDriver () | |
| virtual asynStatus | writeInt32 (asynUser *pasynUser, epicsInt32 value) |
| Called when asyn clients call pasynInt32->write(). More... | |
| virtual asynStatus | writeFloat64 (asynUser *pasynUser, epicsFloat64 value) |
| Called when asyn clients call pasynFloat64->write(). More... | |
| virtual asynStatus | writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual) |
| Called when asyn clients call pasynOctet->write(). More... | |
| virtual asynStatus | readInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynInt32Array->read(). More... | |
| virtual void | driverCallback (asynUser *pasynUser, void *genericPointer) |
| Method that is called from the driver with a new NDArray. More... | |
| virtual void | run (void) |
| Starts the thread that receives NDArrays from the epicsMessageQueue. More... | |
| virtual asynStatus | start (void) |
| Starts the plugin threads. More... | |
| void | sortingTask () |
| Method runs as a separate thread, periodically doing NDArray callbacks to downstream plugins. More... | |
| Public Member Functions inherited from asynNDArrayDriver | |
| asynNDArrayDriver (const char *portName, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) | |
| This is the constructor for the asynNDArrayDriver class. More... | |
| virtual | ~asynNDArrayDriver () |
| virtual asynStatus | readGenericPointer (asynUser *pasynUser, void *genericPointer) |
| This method copies an NDArray object from the asynNDArrayDriver to an NDArray pointer passed in by the caller. More... | |
| virtual asynStatus | writeGenericPointer (asynUser *pasynUser, void *genericPointer) |
| This method currently does nothing, but it should be implemented in this base class. More... | |
| virtual asynStatus | setIntegerParam (int index, int value) |
| Sets the value for an integer in the parameter library. More... | |
| virtual asynStatus | setIntegerParam (int list, int index, int value) |
| Sets the value for an integer in the parameter library. More... | |
| virtual void | report (FILE *fp, int details) |
| Report status of the driver. More... | |
| virtual asynStatus | createFilePath (const char *path, int pathDepth) |
| Function to create a directory path for a file. More... | |
| virtual asynStatus | checkPath () |
| Checks whether the directory specified NDFilePath parameter exists. More... | |
| virtual bool | checkPath (std::string &filePath) |
| Checks whether the directory specified exists. More... | |
| virtual asynStatus | createFileName (int maxChars, char *fullFileName) |
| Build a file name from component parts. More... | |
| virtual asynStatus | createFileName (int maxChars, char *filePath, char *fileName) |
| Build a file name from component parts. More... | |
| virtual asynStatus | readNDAttributesFile () |
| Create this driver's NDAttributeList (pAttributeList) by reading an XML file This clears any existing attributes from this drivers' NDAttributeList and then creates a new list based on the XML file. More... | |
| virtual asynStatus | getAttributes (NDAttributeList *pAttributeList) |
| Get the current values of attributes from this driver and appends them to an output attribute list. More... | |
| virtual void | updateTimeStamps (NDArray *pArray) |
| asynStatus | incrementQueuedArrayCount () |
| asynStatus | decrementQueuedArrayCount () |
| int | getQueuedArrayCount () |
| void | updateQueuedArrayCount () |
Additional Inherited Members | |
| Public Attributes inherited from asynNDArrayDriver | |
| class NDArrayPool * | pNDArrayPool |
| An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More... | |
| Protected Member Functions inherited from NDPluginDriver | |
| virtual void | beginProcessCallbacks (NDArray *pArray) |
| Method that is normally called at the beginning of the processCallbacks method in derived classes. More... | |
| virtual asynStatus | endProcessCallbacks (NDArray *pArray, bool copyArray=false, bool readAttributes=true) |
| Method that is normally called at the end of the processCallbacks()) method in derived classes. More... | |
| virtual asynStatus | connectToArrayPort (void) |
| Connect this plugin to an NDArray port driver; disconnect from any existing driver first, register for callbacks if enabled. More... | |
| virtual asynStatus | setArrayInterrupt (int connect) |
| Register or unregister to receive asynGenericPointer (NDArray) callbacks from the driver. More... | |
| bool | throttled (NDArray *pArray) |
Detailed Description
Converts NDArray callback data into EPICS V4 NTNDArray data and exposes it as an EPICS V4 PV
Constructor & Destructor Documentation
◆ NDPluginPva()
| NDPluginPva::NDPluginPva | ( | const char * | portName, |
| int | queueSize, | ||
| int | blockingCallbacks, | ||
| const char * | NDArrayPort, | ||
| int | NDArrayAddr, | ||
| const char * | pvName, | ||
| int | maxBuffers, | ||
| size_t | maxMemory, | ||
| int | priority, | ||
| int | stackSize | ||
| ) |
Constructor for NDPluginPva This plugin cannot block (ASYN_CANBLOCK=0) and is not multi-device (ASYN_MULTIDEVICE=0).
- Parameters
-
[in] portName The name of the asyn port driver to be created. [in] queueSize The number of NDArrays that the input queue for this plugin can hold when NDPluginDriverBlockingCallbacks=0. Larger queues can decrease the number of dropped arrays, at the expense of more NDArray buffers being allocated from the underlying driver's NDArrayPool. [in] blockingCallbacks Initial setting for the NDPluginDriverBlockingCallbacks flag. 0=callbacks are queued and executed by the callback thread; 1 callbacks execute in the thread of the driver doing the callbacks. [in] NDArrayPort Name of asyn port driver for initial source of NDArray callbacks. [in] NDArrayAddr asyn port driver address for initial source of NDArray callbacks. [in] pvName Name of the PV that will be served by the EPICSv4 server. [in] maxBuffers The maximum number of NDArray buffers that the NDArrayPool for this driver is allowed to allocate. Set this to 0 to allow an unlimited number of buffers. [in] maxMemory The maximum amount of memory that the NDArrayPool for this driver is allowed to allocate. Set this to 0 to allow an unlimited amount of memory. [in] priority The thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags. This value should also be used for any other threads this object creates. [in] stackSize The stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags. This value should also be used for any other threads this object creates.
Member Function Documentation
◆ POINTER_DEFINITIONS()
| NDPluginPva::POINTER_DEFINITIONS | ( | NDPluginPva | ) |
◆ processCallbacks()
|
virtual |
Callback function that is called by the NDArray driver with new NDArray data.
- Parameters
-
[in] pArray The NDArray from the callback.
Implements NDPluginDriver.
Member Data Documentation
◆ NDPluginPvaPvName
|
protected |
The documentation for this class was generated from the following files:
- /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginPva.h
- /home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPluginPva.cpp
