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

Performs a scope like capture. More...

#include <NDPluginCircularBuff.h>

Inheritance diagram for NDPluginCircularBuff:
NDPluginDriver asynNDArrayDriver

Public Member Functions

 NDPluginCircularBuff (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for NDPluginCircularBuff; most parameters are simply passed to NDPluginDriver::NDPluginDriver. More...
 
void processCallbacks (NDArray *pArray)
 Callback function that is called by the NDArray driver with new NDArray data. More...
 
asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Called when asyn clients call pasynInt32->write(). More...
 
asynStatus writeOctet (asynUser *pasynUser, const char *value, size_t nChars, size_t *nActual)
 Called when asyn clients call pasynOctet->write(). 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 writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 Called when asyn clients call pasynFloat64->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

void flushPreBuffer ()
 
- 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)
 

Protected Attributes

int NDCircBuffControl
 
int NDCircBuffStatus
 
int NDCircBuffTriggerA
 
int NDCircBuffTriggerB
 
int NDCircBuffTriggerAVal
 
int NDCircBuffTriggerBVal
 
int NDCircBuffTriggerCalc
 
int NDCircBuffTriggerCalcVal
 
int NDCircBuffPresetTriggerCount
 
int NDCircBuffActualTriggerCount
 
int NDCircBuffPreTrigger
 
int NDCircBuffPostTrigger
 
int NDCircBuffCurrentImage
 
int NDCircBuffPostCount
 
int NDCircBuffSoftTrigger
 
int NDCircBuffTriggered
 
int NDCircBuffFlushOnSoftTrig
 
- Protected Attributes inherited from NDPluginDriver
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

Performs a scope like capture.

Records a quantity of pre-trigger and post-trigger images

Constructor & Destructor Documentation

◆ NDPluginCircularBuff()

NDPluginCircularBuff::NDPluginCircularBuff ( const char *  portName,
int  queueSize,
int  blockingCallbacks,
const char *  NDArrayPort,
int  NDArrayAddr,
int  maxBuffers,
size_t  maxMemory,
int  priority,
int  stackSize 
)

Constructor for NDPluginCircularBuff; most parameters are simply passed to NDPluginDriver::NDPluginDriver.

After calling the base class constructor this method sets reasonable default values for all of the parameters.

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]maxBuffersThe maximum number of NDArray buffers that the NDArrayPool for this driver is allowed to allocate. Set this to -1 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 -1 to allow an unlimited amount of memory.
[in]priorityThe thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]stackSizeThe stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

◆ flushPreBuffer()

void NDPluginCircularBuff::flushPreBuffer ( )
protected

◆ processCallbacks()

void NDPluginCircularBuff::processCallbacks ( NDArray pArray)
virtual

Callback function that is called by the NDArray driver with new NDArray data.

Stores the number of pre-trigger images prior to the trigger in a ring buffer. Once the trigger has been received stores the number of post-trigger buffers and then exposes the buffers.

Parameters
[in]pArrayThe NDArray from the callback.

Implements NDPluginDriver.

◆ writeInt32()

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

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

This function performs actions for some parameters. 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 NDPluginDriver.

◆ writeOctet()

asynStatus NDPluginCircularBuff::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 AttributesFile. 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 NDPluginDriver.

Member Data Documentation

◆ NDCircBuffActualTriggerCount

int NDPluginCircularBuff::NDCircBuffActualTriggerCount
protected

◆ NDCircBuffControl

int NDPluginCircularBuff::NDCircBuffControl
protected

◆ NDCircBuffCurrentImage

int NDPluginCircularBuff::NDCircBuffCurrentImage
protected

◆ NDCircBuffFlushOnSoftTrig

int NDPluginCircularBuff::NDCircBuffFlushOnSoftTrig
protected

◆ NDCircBuffPostCount

int NDPluginCircularBuff::NDCircBuffPostCount
protected

◆ NDCircBuffPostTrigger

int NDPluginCircularBuff::NDCircBuffPostTrigger
protected

◆ NDCircBuffPresetTriggerCount

int NDPluginCircularBuff::NDCircBuffPresetTriggerCount
protected

◆ NDCircBuffPreTrigger

int NDPluginCircularBuff::NDCircBuffPreTrigger
protected

◆ NDCircBuffSoftTrigger

int NDPluginCircularBuff::NDCircBuffSoftTrigger
protected

◆ NDCircBuffStatus

int NDPluginCircularBuff::NDCircBuffStatus
protected

◆ NDCircBuffTriggerA

int NDPluginCircularBuff::NDCircBuffTriggerA
protected

◆ NDCircBuffTriggerAVal

int NDPluginCircularBuff::NDCircBuffTriggerAVal
protected

◆ NDCircBuffTriggerB

int NDPluginCircularBuff::NDCircBuffTriggerB
protected

◆ NDCircBuffTriggerBVal

int NDPluginCircularBuff::NDCircBuffTriggerBVal
protected

◆ NDCircBuffTriggerCalc

int NDPluginCircularBuff::NDCircBuffTriggerCalc
protected

◆ NDCircBuffTriggerCalcVal

int NDPluginCircularBuff::NDCircBuffTriggerCalcVal
protected

◆ NDCircBuffTriggered

int NDPluginCircularBuff::NDCircBuffTriggered
protected

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