areaDetector  3-7-0
EPICS areaDetector framework
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NDPluginDriver Class Referenceabstract

Class from which actual plugin drivers are derived; derived from asynNDArrayDriver. More...

#include <NDPluginDriver.h>

Inheritance diagram for NDPluginDriver:
asynNDArrayDriver ADnEDPixelROI ffmpegStream NDPluginAttribute NDPluginAttrPlot NDPluginCircularBuff NDPluginCodec NDPluginColorConvert NDPluginEdge NDPluginFFT NDPluginFile NDPluginGather NDPluginMask NDPluginOverlay NDPluginProcess NDPluginPva NDPluginROI NDPluginROIStat NDPluginScatter NDPluginStats NDPluginStdArrays NDPluginTimeSeries NDPluginTransform NDPosPlugin

Public Member Functions

 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 readInt32 (asynUser *pasynUser, epicsInt32 *value)
 
virtual asynStatus readFloat64 (asynUser *pasynUser, epicsFloat64 *value)
 
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...
 
asynStatus incrementQueuedArrayCount ()
 
asynStatus decrementQueuedArrayCount ()
 
int getQueuedArrayCount ()
 
void updateQueuedArrayCount ()
 

Protected Member Functions

virtual void processCallbacks (NDArray *pArray)=0
 
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)
 

Protected Attributes

int NDPluginDriverArrayPort
 
int NDPluginDriverArrayAddr
 
int NDPluginDriverPluginType
 
int NDPluginDriverDroppedArrays
 
int NDPluginDriverQueueSize
 
int NDPluginDriverQueueFree
 
int NDPluginDriverMaxThreads
 
int NDPluginDriverNumThreads
 
int NDPluginDriverSortMode
 
int NDPluginDriverSortTime
 
int NDPluginDriverSortSize
 
int NDPluginDriverSortFree
 
int NDPluginDriverDisorderedArrays
 
int NDPluginDriverDroppedOutputArrays
 
int NDPluginDriverEnableCallbacks
 
int NDPluginDriverBlockingCallbacks
 
int NDPluginDriverProcessPlugin
 
int NDPluginDriverExecutionTime
 
int NDPluginDriverMinCallbackTime
 
int NDPluginDriverMaxByteRate
 
NDArraypPrevInputArray_
 
- Protected Attributes inherited from asynNDArrayDriver
int NDPortNameSelf
 
int NDADCoreVersion
 
int NDDriverVersion
 
int NDArraySizeX
 
int NDArraySizeY
 
int NDArraySizeZ
 
int NDArraySize
 
int NDNDimensions
 
int NDDimensions
 
int NDDataType
 
int NDColorMode
 
int NDUniqueId
 
int NDTimeStamp
 
int NDEpicsTSSec
 
int NDEpicsTSNsec
 
int NDBayerPattern
 
int NDCodec
 
int NDCompressedSize
 
int NDArrayCounter
 
int NDFilePath
 
int NDFilePathExists
 
int NDFileName
 
int NDFileNumber
 
int NDFileTemplate
 
int NDAutoIncrement
 
int NDFullFileName
 
int NDFileFormat
 
int NDAutoSave
 
int NDWriteFile
 
int NDReadFile
 
int NDFileWriteMode
 
int NDFileWriteStatus
 
int NDFileWriteMessage
 
int NDFileNumCapture
 
int NDFileNumCaptured
 
int NDFileCapture
 
int NDFileDeleteDriverFile
 
int NDFileLazyOpen
 
int NDFileCreateDir
 
int NDFileTempSuffix
 
int NDAttributesFile
 
int NDAttributesStatus
 
int NDAttributesMacros
 
int NDArrayData
 
int NDArrayCallbacks
 
int NDPoolMaxBuffers
 
int NDPoolAllocBuffers
 
int NDPoolFreeBuffers
 
int NDPoolMaxMemory
 
int NDPoolUsedMemory
 
int NDPoolEmptyFreeList
 
int NDNumQueuedArrays
 
class NDArray ** pArrays
 An array of NDArray pointers used to store data in the driver. More...
 
class NDAttributeListpAttributeList
 An NDAttributeList object used to obtain the current values of a set of attributes. More...
 
int threadStackSize_
 
int threadPriority_
 

Additional Inherited Members

- Public Attributes inherited from asynNDArrayDriver
class NDArrayPoolpNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 

Detailed Description

Class from which actual plugin drivers are derived; derived from asynNDArrayDriver.

Constructor & Destructor Documentation

◆ NDPluginDriver()

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.

After calling the base class constructor this method creates a thread to execute the NDArray callbacks, and sets reasonable default values for all of the parameters defined in NDPluginDriver.h.

Parameters
[in]portNameThe name of the asyn port driver to be created.
[in]queueSizeThe 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]blockingCallbacksInitial 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]NDArrayPortName of asyn port driver for initial source of NDArray callbacks.
[in]NDArrayAddrasyn port driver address for initial source of NDArray callbacks.
[in]maxAddrThe maximum number of asyn addr addresses this driver supports. 1 is minimum.
[in]maxBuffersThe 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]maxMemoryThe 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]interfaceMaskBit mask defining the asyn interfaces that this driver supports.
[in]interruptMaskBit mask definining the asyn interfaces that can generate interrupts (callbacks)
[in]asynFlagsFlags when creating the asyn port driver; includes ASYN_CANBLOCK and ASYN_MULTIDEVICE.
[in]autoConnectThe autoConnect flag for the asyn port driver.
[in]priorityThe 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]stackSizeThe 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.
[in]maxThreadsThe maximum number of threads this plugin is allowed to use.
[in]compressionAwaretrue if the plugin can handle compressed input arrays, false if not.

◆ ~NDPluginDriver()

NDPluginDriver::~NDPluginDriver ( )

Member Function Documentation

◆ beginProcessCallbacks()

void NDPluginDriver::beginProcessCallbacks ( NDArray pArray)
protectedvirtual

Method that is normally called at the beginning of the processCallbacks method in derived classes.

Parameters
[in]pArrayThe NDArray from the callback.

This method takes care of some bookkeeping for callbacks, updating parameters from data in the class and in the NDArray. It does asynInt32Array callbacks for the dimensions array if the dimensions of the NDArray data have changed.

◆ connectToArrayPort()

asynStatus NDPluginDriver::connectToArrayPort ( void  )
protectedvirtual

Connect this plugin to an NDArray port driver; disconnect from any existing driver first, register for callbacks if enabled.

Reimplemented in NDPluginGather.

◆ driverCallback()

void NDPluginDriver::driverCallback ( asynUser *  pasynUser,
void *  genericPointer 
)
virtual

Method that is called from the driver with a new NDArray.

It calls the processCallbacks function, which typically is implemented in the derived class. It can either do the callbacks directly (if NDPluginDriverBlockingCallbacks=1) or by queueing the arrays to be processed by a background task (if NDPluginDriverBlockingCallbacks=0). In the latter case arrays can be dropped if the queue is full. This method should really be private, but it must be called from a C-linkage callback function, so it must be public.

Parameters
[in]pasynUserThe pasynUser from the asyn client.
[in]genericPointerThe pointer to the NDArray

◆ endProcessCallbacks()

asynStatus NDPluginDriver::endProcessCallbacks ( NDArray pArray,
bool  copyArray = false,
bool  readAttributes = true 
)
protectedvirtual

Method that is normally called at the end of the processCallbacks()) method in derived classes.

Parameters
[in]pArrayThe NDArray from the callback.
[in]copyArrayThis flag should be true if pArray is the original array passed to processCallbacks(). It must be false if the derived class if pArray is a new NDArray that processCallbacks() created
[in]readAttributesThis flag must be true if the derived class has not yet called readAttributes() for pArray.

This method does NDArray callbacks to downstream plugins if NDArrayCallbacks is true and SortMode is Unsorted. If SortMode is sorted it inserts the NDArray into the std::multilist for callbacks in SortThread(). It keeps track of DisorderedArrays and DroppedOutputArrays. It caches the most recent NDArray in pArrays[0].

◆ processCallbacks()

virtual void NDPluginDriver::processCallbacks ( NDArray pArray)
protectedpure virtual

◆ readInt32Array()

asynStatus NDPluginDriver::readInt32Array ( asynUser *  pasynUser,
epicsInt32 *  value,
size_t  nElements,
size_t *  nIn 
)
virtual

Called when asyn clients call pasynInt32Array->read().

Returns the value of the array dimensions for the last NDArray.

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valuePointer to the array to read.
[in]nElementsNumber of elements to read.
[out]nInNumber of elements actually read.

Reimplemented in NDPluginStdArrays.

◆ run()

void NDPluginDriver::run ( void  )
virtual

Starts the thread that receives NDArrays from the epicsMessageQueue.

◆ setArrayInterrupt()

asynStatus NDPluginDriver::setArrayInterrupt ( int  enableCallbacks)
protectedvirtual

Register or unregister to receive asynGenericPointer (NDArray) callbacks from the driver.

Note: this function must be called with the lock released, otherwise a deadlock can occur in the call to cancelInterruptUser.

Parameters
[in]enableCallbacks1 to enable callbacks, 0 to disable callbacks

Reimplemented in NDPluginGather.

◆ sortingTask()

void NDPluginDriver::sortingTask ( )

Method runs as a separate thread, periodically doing NDArray callbacks to downstream plugins.

This thread is used when SortMode=1. This method should really be private, but it must be called from a C-linkage callback function, so it must be public.

◆ start()

asynStatus NDPluginDriver::start ( void  )
virtual

Starts the plugin threads.

This method must be called after the derived class object is fully constructed.

◆ throttled()

bool NDPluginDriver::throttled ( NDArray pArray)
protected

◆ writeFloat64()

asynStatus NDPluginDriver::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
)
virtual

Called when asyn clients call pasynFloat64->write().

This function performs actions for NDPluginDriverMaxByteRate. For all parameters it sets the value in the parameter library and calls any registered callbacks..

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented in NDPluginStats, NDPluginTimeSeries, and ffmpegFile.

◆ writeInt32()

asynStatus NDPluginDriver::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
)
virtual

Called when asyn clients call pasynInt32->write().

This function performs actions for some parameters, including NDPluginDriverEnableCallbacks and NDPluginDriverArrayAddr. For all parameters it sets the value in the parameter library and calls any registered callbacks..

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from asynNDArrayDriver.

Reimplemented in NDPluginStats, NDPluginAttrPlot, NDPluginROIStat, NDFileHDF5, NDPosPlugin, NDPluginCodec, NDPluginOverlay, NDPluginProcess, NDPluginROI, NDPluginTimeSeries, NDPluginCircularBuff, NDPluginFile, and NDPluginAttribute.

◆ writeOctet()

asynStatus NDPluginDriver::writeOctet ( asynUser *  pasynUser,
const char *  value,
size_t  nChars,
size_t *  nActual 
)
virtual

Called when asyn clients call pasynOctet->write().

This function performs actions for some parameters, including NDPluginDriverArrayPort. For all parameters it sets the value in the parameter library and calls any registered callbacks..

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueAddress of the string to write.
[in]nCharsNumber of characters to write.
[out]nActualNumber of characters actually written.

Reimplemented from asynNDArrayDriver.

Reimplemented in NDFileHDF5, NDPosPlugin, NDFileNexus, and NDPluginCircularBuff.

Member Data Documentation

◆ NDPluginDriverArrayAddr

int NDPluginDriver::NDPluginDriverArrayAddr
protected

◆ NDPluginDriverArrayPort

int NDPluginDriver::NDPluginDriverArrayPort
protected

◆ NDPluginDriverBlockingCallbacks

int NDPluginDriver::NDPluginDriverBlockingCallbacks
protected

◆ NDPluginDriverDisorderedArrays

int NDPluginDriver::NDPluginDriverDisorderedArrays
protected

◆ NDPluginDriverDroppedArrays

int NDPluginDriver::NDPluginDriverDroppedArrays
protected

◆ NDPluginDriverDroppedOutputArrays

int NDPluginDriver::NDPluginDriverDroppedOutputArrays
protected

◆ NDPluginDriverEnableCallbacks

int NDPluginDriver::NDPluginDriverEnableCallbacks
protected

◆ NDPluginDriverExecutionTime

int NDPluginDriver::NDPluginDriverExecutionTime
protected

◆ NDPluginDriverMaxByteRate

int NDPluginDriver::NDPluginDriverMaxByteRate
protected

◆ NDPluginDriverMaxThreads

int NDPluginDriver::NDPluginDriverMaxThreads
protected

◆ NDPluginDriverMinCallbackTime

int NDPluginDriver::NDPluginDriverMinCallbackTime
protected

◆ NDPluginDriverNumThreads

int NDPluginDriver::NDPluginDriverNumThreads
protected

◆ NDPluginDriverPluginType

int NDPluginDriver::NDPluginDriverPluginType
protected

◆ NDPluginDriverProcessPlugin

int NDPluginDriver::NDPluginDriverProcessPlugin
protected

◆ NDPluginDriverQueueFree

int NDPluginDriver::NDPluginDriverQueueFree
protected

◆ NDPluginDriverQueueSize

int NDPluginDriver::NDPluginDriverQueueSize
protected

◆ NDPluginDriverSortFree

int NDPluginDriver::NDPluginDriverSortFree
protected

◆ NDPluginDriverSortMode

int NDPluginDriver::NDPluginDriverSortMode
protected

◆ NDPluginDriverSortSize

int NDPluginDriver::NDPluginDriverSortSize
protected

◆ NDPluginDriverSortTime

int NDPluginDriver::NDPluginDriverSortTime
protected

◆ pPrevInputArray_

NDArray* NDPluginDriver::pPrevInputArray_
protected

The documentation for this class was generated from the following files: