areaDetector  3-5-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 asynPortDriver 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)
 Called when asyn clients call pasynInt32->read(). More...
 
virtual asynStatus readFloat64 (asynUser *pasynUser, epicsFloat64 *value)
 Called when asyn clients call pasynFloat64->read(). 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...
 
asynStatus incrementQueuedArrayCount ()
 
asynStatus decrementQueuedArrayCount ()
 
int getQueuedArrayCount ()
 
void updateQueuedArrayCount ()
 
- Public Member Functions inherited from asynPortDriver
 asynPortDriver (const char *portName, int maxAddr, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
 Constructor for the asynPortDriver class. More...
 
 asynPortDriver (const char *portName, int maxAddr, int paramTableSize, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) EPICS_DEPRECATED
 Legacy constructor for the asynPortDriver class (DEPRECATED - please use the one above instead). More...
 
virtual ~asynPortDriver ()
 Destructor for asynPortDriver class; frees resources allocated when port driver is created. More...
 
virtual asynStatus lock ()
 Locks the driver to prevent multiple threads from accessing memory at the same time. More...
 
virtual asynStatus unlock ()
 Unlocks the driver; called when an asyn client or driver is done accessing common memory. More...
 
virtual asynStatus getAddress (asynUser *pasynUser, int *address)
 Returns the asyn address associated with a pasynUser structure. More...
 
virtual asynStatus readUInt32Digital (asynUser *pasynUser, epicsUInt32 *value, epicsUInt32 mask)
 Called when asyn clients call pasynUInt32Digital->read(). More...
 
virtual asynStatus writeUInt32Digital (asynUser *pasynUser, epicsUInt32 value, epicsUInt32 mask)
 Called when asyn clients call pasynUInt32Digital->write(). More...
 
virtual asynStatus setInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 mask, interruptReason reason)
 Called when asyn clients call pasynUInt32Digital->setInterrupt(). More...
 
virtual asynStatus clearInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 mask)
 Called when asyn clients call pasynUInt32Digital->clearInterrupt(). More...
 
virtual asynStatus getInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 *mask, interruptReason reason)
 Called when asyn clients call pasynUInt32Digital->getInterrupt(). More...
 
virtual asynStatus getBounds (asynUser *pasynUser, epicsInt32 *low, epicsInt32 *high)
 Called when asyn clients call pasynInt32->getBounds(), returning the bounds on the asynInt32 interface for drivers that use raw units. More...
 
virtual asynStatus readOctet (asynUser *pasynUser, char *value, size_t maxChars, size_t *nActual, int *eomReason)
 Called when asyn clients call pasynOctet->read(). More...
 
virtual asynStatus flushOctet (asynUser *pasynUser)
 Called when asyn clients call pasynOctet->flush(). More...
 
virtual asynStatus setInputEosOctet (asynUser *pasynUser, const char *eos, int eosLen)
 Called when asyn clients call pasynOctet->setInputEos(). More...
 
virtual asynStatus getInputEosOctet (asynUser *pasynUser, char *eos, int eosSize, int *eosLen)
 Called when asyn clients call pasynOctet->getInputEos(). More...
 
virtual asynStatus setOutputEosOctet (asynUser *pasynUser, const char *eos, int eosLen)
 Called when asyn clients call pasynOctet->setOutputEos(). More...
 
virtual asynStatus getOutputEosOctet (asynUser *pasynUser, char *eos, int eosSize, int *eosLen)
 Called when asyn clients call pasynOctet->getOutputEos(). More...
 
virtual asynStatus readInt8Array (asynUser *pasynUser, epicsInt8 *value, size_t nElements, size_t *nIn)
 Called when asyn clients call pasynInt8Array->read(). More...
 
virtual asynStatus writeInt8Array (asynUser *pasynUser, epicsInt8 *value, size_t nElements)
 Called when asyn clients call pasynInt8Array->write(). More...
 
virtual asynStatus doCallbacksInt8Array (epicsInt8 *value, size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynInt8Array interface. More...
 
virtual asynStatus readInt16Array (asynUser *pasynUser, epicsInt16 *value, size_t nElements, size_t *nIn)
 Called when asyn clients call pasynInt16Array->read(). More...
 
virtual asynStatus writeInt16Array (asynUser *pasynUser, epicsInt16 *value, size_t nElements)
 Called when asyn clients call pasynInt16Array->write(). More...
 
virtual asynStatus doCallbacksInt16Array (epicsInt16 *value, size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynInt16Array interface. More...
 
virtual asynStatus writeInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements)
 Called when asyn clients call pasynInt32Array->write(). More...
 
virtual asynStatus doCallbacksInt32Array (epicsInt32 *value, size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynInt32Array interface. More...
 
virtual asynStatus readFloat32Array (asynUser *pasynUser, epicsFloat32 *value, size_t nElements, size_t *nIn)
 Called when asyn clients call pasynFloat32Array->read(). More...
 
virtual asynStatus writeFloat32Array (asynUser *pasynUser, epicsFloat32 *value, size_t nElements)
 Called when asyn clients call pasynFloat32Array->write(). More...
 
virtual asynStatus doCallbacksFloat32Array (epicsFloat32 *value, size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynFloat32Array interface. More...
 
virtual asynStatus readFloat64Array (asynUser *pasynUser, epicsFloat64 *value, size_t nElements, size_t *nIn)
 Called when asyn clients call pasynFloat64Array->read(). More...
 
virtual asynStatus writeFloat64Array (asynUser *pasynUser, epicsFloat64 *value, size_t nElements)
 Called when asyn clients call pasynFloat64Array->write(). More...
 
virtual asynStatus doCallbacksFloat64Array (epicsFloat64 *value, size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynFloat64Array interface. More...
 
virtual asynStatus doCallbacksGenericPointer (void *pointer, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynGenericPointer interface. More...
 
virtual asynStatus readOption (asynUser *pasynUser, const char *key, char *value, int maxChars)
 Called when asyn clients call pasynOption->read(). More...
 
virtual asynStatus writeOption (asynUser *pasynUser, const char *key, const char *value)
 Called when asyn clients call pasynOption->write(). More...
 
virtual asynStatus readEnum (asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements, size_t *nIn)
 Called when asyn clients call pasynEnum->read(). More...
 
virtual asynStatus writeEnum (asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements)
 Called when asyn clients call pasynEnum->write(). More...
 
virtual asynStatus doCallbacksEnum (char *strings[], int values[], int severities[], size_t nElements, int reason, int addr)
 Called by driver to do the callbacks to registered clients on the asynEnum interface. More...
 
virtual asynStatus drvUserCreate (asynUser *pasynUser, const char *drvInfo, const char **pptypeName, size_t *psize)
 Called by asynManager to pass a pasynUser structure and drvInfo string to the driver; Assigns pasynUser->reason based on the value of the drvInfo string. More...
 
virtual asynStatus drvUserGetType (asynUser *pasynUser, const char **pptypeName, size_t *psize)
 Returns strings associated with driver-specific commands. More...
 
virtual asynStatus drvUserDestroy (asynUser *pasynUser)
 Frees any resources allocated by drvUserCreate. More...
 
virtual asynStatus connect (asynUser *pasynUser)
 Connects driver to device; The base class implementation simply calls pasynManager->exceptionConnect if address is valid Derived classes can reimplement this function for real connection management. More...
 
virtual asynStatus disconnect (asynUser *pasynUser)
 Disconnects driver from device; the base class implementation simply calls pasynManager->exceptionDisconnect. More...
 
virtual asynStatus createParam (const char *name, asynParamType type, int *index)
 Creates a parameter in the parameter library. More...
 
virtual asynStatus createParam (int list, const char *name, asynParamType type, int *index)
 Creates a parameter in the parameter library. More...
 
virtual asynStatus getNumParams (int *numParams)
 Returns the number of parameters in the parameter library. More...
 
virtual asynStatus getNumParams (int list, int *numParams)
 Returns the number of parameters in the parameter library. More...
 
virtual asynStatus findParam (const char *name, int *index)
 Finds a parameter in the parameter library. More...
 
virtual asynStatus findParam (int list, const char *name, int *index)
 Finds a parameter in the parameter library. More...
 
virtual asynStatus getParamName (int index, const char **name)
 Returns the name of a parameter in the parameter library. More...
 
virtual asynStatus getParamName (int list, int index, const char **name)
 Returns the name of a parameter in the parameter library. More...
 
virtual asynStatus getParamType (int index, asynParamType *type)
 Returns the asynParamType of a parameter in the parameter library*. More...
 
virtual asynStatus getParamType (int list, int index, asynParamType *type)
 Returns the asynParamType of a parameter in the parameter library. More...
 
virtual asynStatus setParamStatus (int index, asynStatus status)
 Sets the status for a parameter in the parameter library. More...
 
virtual asynStatus setParamStatus (int list, int index, asynStatus status)
 Sets the status for a parameter in the parameter library. More...
 
virtual asynStatus getParamStatus (int index, asynStatus *status)
 Gets the status for a parameter in the parameter library. More...
 
virtual asynStatus getParamStatus (int list, int index, asynStatus *status)
 Gets the status for a parameter in the parameter library. More...
 
virtual asynStatus setParamAlarmStatus (int index, int status)
 Sets the alarmStatus for a parameter in the parameter library. More...
 
virtual asynStatus setParamAlarmStatus (int list, int index, int status)
 Sets the alarmStatus for a parameter in the parameter library. More...
 
virtual asynStatus getParamAlarmStatus (int index, int *status)
 Gets the alarmStatus for a parameter in the parameter library. More...
 
virtual asynStatus getParamAlarmStatus (int list, int index, int *status)
 Gets the alarmStatus for a parameter in the parameter library. More...
 
virtual asynStatus setParamAlarmSeverity (int index, int severity)
 Sets the alarmSeverity for a parameter in the parameter library. More...
 
virtual asynStatus setParamAlarmSeverity (int list, int index, int severity)
 Sets the alarmSeverity for a parameter in the parameter library. More...
 
virtual asynStatus getParamAlarmSeverity (int index, int *severity)
 Gets the alarmSeverity for a parameter in the parameter library. More...
 
virtual asynStatus getParamAlarmSeverity (int list, int index, int *severity)
 Gets the alarmSeverity for a parameter in the parameter library. More...
 
virtual void reportSetParamErrors (asynStatus status, int index, int list, const char *functionName)
 Reports errors when setting parameters. More...
 
virtual void reportGetParamErrors (asynStatus status, int index, int list, const char *functionName)
 Reports errors when getting parameters. 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 asynStatus setUIntDigitalParam (int index, epicsUInt32 value, epicsUInt32 valueMask)
 Sets the value for a UInt32Digital in the parameter library. More...
 
virtual asynStatus setUIntDigitalParam (int list, int index, epicsUInt32 value, epicsUInt32 valueMask)
 Sets the value for a UInt32Digital in the parameter library. More...
 
virtual asynStatus setUIntDigitalParam (int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask)
 Sets the value for a UInt32Digital in the parameter library. More...
 
virtual asynStatus setUIntDigitalParam (int list, int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask)
 Sets the value for a UInt32Digital in the parameter library. More...
 
virtual asynStatus setUInt32DigitalInterrupt (int index, epicsUInt32 mask, interruptReason reason)
 Sets the interrupt mask and reason in the parameter library Calls paramList::setUInt32Interrupt (0, index, mask, reason) i.e. More...
 
virtual asynStatus setUInt32DigitalInterrupt (int list, int index, epicsUInt32 mask, interruptReason reason)
 Sets the interrupt mask and reason in the parameter library Calls paramList::setUInt32Interrupt (index, mask, reason) for the parameter list indexed by list. More...
 
virtual asynStatus clearUInt32DigitalInterrupt (int index, epicsUInt32 mask)
 Clears the interrupt mask in the parameter library Calls paramList::clearUInt32Interrupt (0, index, mask) i.e. More...
 
virtual asynStatus clearUInt32DigitalInterrupt (int list, int index, epicsUInt32 mask)
 Clears the interrupt mask in the parameter library Calls paramList::clearUInt32Interrupt (index, mask) for the parameter list indexed by list. More...
 
virtual asynStatus getUInt32DigitalInterrupt (int index, epicsUInt32 *mask, interruptReason reason)
 Gets the interrupt mask and reason in the parameter library Calls paramList::getUInt32Interrupt (0, index, mask, reason) i.e. More...
 
virtual asynStatus getUInt32DigitalInterrupt (int list, int index, epicsUInt32 *mask, interruptReason reason)
 Gets the interrupt mask and reason in the parameter library Calls paramList::getUInt32Interrupt (index, mask, reason) for the parameter list indexed by list. More...
 
virtual asynStatus setDoubleParam (int index, double value)
 Sets the value for a double in the parameter library. More...
 
virtual asynStatus setDoubleParam (int list, int index, double value)
 Sets the value for a double in the parameter library. More...
 
virtual asynStatus setStringParam (int index, const char *value)
 Sets the value for a string in the parameter library. More...
 
virtual asynStatus setStringParam (int list, int index, const char *value)
 Sets the value for a string in the parameter library. More...
 
virtual asynStatus setStringParam (int index, const std::string &value)
 Sets the value for a string in the parameter library. More...
 
virtual asynStatus setStringParam (int list, int index, const std::string &value)
 Sets the value for a string in the parameter library. More...
 
virtual asynStatus getIntegerParam (int index, epicsInt32 *value)
 Returns the value for an integer from the parameter library. More...
 
virtual asynStatus getIntegerParam (int list, int index, epicsInt32 *value)
 Returns the value for an integer from the parameter library. More...
 
virtual asynStatus getUIntDigitalParam (int index, epicsUInt32 *value, epicsUInt32 mask)
 Returns the value for an UInt32Digital parameter from the parameter library. More...
 
virtual asynStatus getUIntDigitalParam (int list, int index, epicsUInt32 *value, epicsUInt32 mask)
 Returns the value for an UInt32Digital parameter from the parameter library. More...
 
virtual asynStatus getDoubleParam (int index, double *value)
 Returns the value for a double from the parameter library. More...
 
virtual asynStatus getDoubleParam (int list, int index, double *value)
 Returns the value for a double from the parameter library. More...
 
virtual asynStatus getStringParam (int index, int maxChars, char *value)
 Returns the value for a string from the parameter library. More...
 
virtual asynStatus getStringParam (int list, int index, int maxChars, char *value)
 Returns the value for a string from the parameter library. More...
 
virtual asynStatus getStringParam (int index, std::string &value)
 Returns the value for a string from the parameter library. More...
 
virtual asynStatus getStringParam (int list, int index, std::string &value)
 Returns the value for a string from the parameter library. More...
 
virtual asynStatus callParamCallbacks ()
 Calls callParamCallbacks(0, 0) i.e. More...
 
virtual asynStatus callParamCallbacks (int addr)
 Calls callParamCallbacks(addr, addr) i.e. More...
 
virtual asynStatus callParamCallbacks (int list, int addr)
 Calls paramList::callCallbacks(addr) for a specific parameter list. More...
 
virtual asynStatus updateTimeStamp ()
 Updates the timestamp for this port in pasynManager. More...
 
virtual asynStatus updateTimeStamp (epicsTimeStamp *pTimeStamp)
 Updates the timestamp for this port in pasynManager, and returns this timestamp. More...
 
virtual asynStatus getTimeStamp (epicsTimeStamp *pTimeStamp)
 Gets the most recent timestamp for this port from pasynManager. More...
 
virtual asynStatus setTimeStamp (const epicsTimeStamp *pTimeStamp)
 Sets the timestamp for this port in pasynManager. More...
 
asynStandardInterfaces * getAsynStdInterfaces ()
 Returns the asynStdInterfaces structure used by asynPortDriver. More...
 
virtual void reportParams (FILE *fp, int details)
 Calls paramList::report(fp, details) for each parameter list that the driver supports. More...
 
void callbackTask ()
 

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 Member Functions inherited from asynPortDriver
void initialize (const char *portNameIn, int maxAddrIn, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
 The following function is required to initialize from two constructors. More...
 

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_
 
- Protected Attributes inherited from asynPortDriver
asynUser * pasynUserSelf
 asynUser connected to ourselves for asynTrace More...
 
asynStandardInterfaces asynStdInterfaces
 The asyn interfaces this driver implements. More...
 

Additional Inherited Members

- Public Attributes inherited from asynNDArrayDriver
class NDArrayPoolpNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 
- Public Attributes inherited from asynPortDriver
char * portName
 The name of this asyn port. More...
 
int maxAddr
 The maximum asyn address (addr) supported by this driver. 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 from asynPortDriver.

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

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: