#include <NDPosPlugin.h>

Inheritance diagram for NDPosPlugin:

Public Member Functions
	NDPosPlugin (const char portName, int queueSize, int blockingCallbacks, const char NDArrayPort, int NDArrayAddr, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for the NDPosPlugin class. More...

virtual	~NDPosPlugin ()

void	processCallbacks (NDArray *pArray)
	Callback function that is called by the NDArray driver with new NDArray data. More...

asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Sets an int32 parameter. 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	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 ()

Protected Attributes
int	NDPos_Filename

int	NDPos_FileValid

int	NDPos_Clear

int	NDPos_Running

int	NDPos_Restart

int	NDPos_Delete

int	NDPos_Mode

int	NDPos_Append

int	NDPos_CurrentQty

int	NDPos_CurrentIndex

int	NDPos_CurrentPos

int	NDPos_DuplicateFrames

int	NDPos_MissingFrames

int	NDPos_ExpectedID

int	NDPos_IDName

int	NDPos_IDDifference

int	NDPos_IDStart

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

NDArray *	pPrevInputArray_

Protected Attributes inherited from asynNDArrayDriver
int	NDPortNameSelf

int	NDADCoreVersion

int	NDDriverVersion

int	ADManufacturer

int	ADModel

int	ADSerialNumber

int	ADSDKVersion

int	ADFirmwareVersion

int	ADAcquire

int	ADAcquireBusy

int	ADWaitForPlugins

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	NDFileFreeCapture

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	NDPoolPreAllocBuffers

int	NDPoolNumPreAllocBuffers

int	NDPoolFreeBuffers

int	NDPoolMaxMemory

int	NDPoolUsedMemory

int	NDPoolEmptyFreeList

int	NDPoolPollStats

int	NDNumQueuedArrays

class NDArray **	pArrays
	An array of NDArray pointers used to store data in the driver. More...

class NDAttributeList *	pAttributeList
	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 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)

Constructor & Destructor Documentation

◆ NDPosPlugin()

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

Constructor for the NDPosPlugin class.

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

◆ ~NDPosPlugin()

NDPosPlugin::~NDPosPlugin ( )

virtual

Member Function Documentation

◆ processCallbacks()

void NDPosPlugin::processCallbacks ( NDArray * pArray )

virtual

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

If the plugin is running then it attaches position data to the NDArray as NDAttributes and then passes the array on. If the plugin is not running then NDArrays are not passed through to the next plugin(s) in the chain.

Parameters

[in] pArray The NDArray from the callback.

Implements NDPluginDriver.

◆ writeInt32()

asynStatus NDPosPlugin::writeInt32	(	asynUser *	pasynUser,
		epicsInt32	value
	)

virtual

Sets an int32 parameter.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	value	The value for this parameter

Takes action if the function code requires it.

Reimplemented from NDPluginDriver.

◆ writeOctet()

asynStatus NDPosPlugin::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]	pasynUser	pasynUser structure that encodes the reason and address.
[in]	value	Address of the string to write.
[in]	nChars	Number of characters to write.
[out]	nActual	Number of characters actually written.

Reimplemented from NDPluginDriver.

Member Data Documentation

◆ NDPos_Append

int NDPosPlugin::NDPos_Append

protected

◆ NDPos_Clear

int NDPosPlugin::NDPos_Clear

protected

◆ NDPos_CurrentIndex

int NDPosPlugin::NDPos_CurrentIndex

protected

◆ NDPos_CurrentPos

int NDPosPlugin::NDPos_CurrentPos

protected

◆ NDPos_CurrentQty

int NDPosPlugin::NDPos_CurrentQty

protected

◆ NDPos_Delete

int NDPosPlugin::NDPos_Delete

protected

◆ NDPos_DuplicateFrames

int NDPosPlugin::NDPos_DuplicateFrames

protected

◆ NDPos_ExpectedID

int NDPosPlugin::NDPos_ExpectedID

protected

◆ NDPos_Filename

int NDPosPlugin::NDPos_Filename

protected

◆ NDPos_FileValid

int NDPosPlugin::NDPos_FileValid

protected

◆ NDPos_IDDifference

int NDPosPlugin::NDPos_IDDifference

protected

◆ NDPos_IDName

int NDPosPlugin::NDPos_IDName

protected

◆ NDPos_IDStart

int NDPosPlugin::NDPos_IDStart

protected

◆ NDPos_MissingFrames

int NDPosPlugin::NDPos_MissingFrames

protected

◆ NDPos_Mode

int NDPosPlugin::NDPos_Mode

protected

◆ NDPos_Restart

int NDPosPlugin::NDPos_Restart

protected

◆ NDPos_Running

int NDPosPlugin::NDPos_Running

protected

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

/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPosPlugin.h
/home/runner/work/areaDetector/areaDetector/ADCore/ADApp/pluginSrc/NDPosPlugin.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ NDPosPlugin()

◆ ~NDPosPlugin()

Member Function Documentation

◆ processCallbacks()

◆ writeInt32()

◆ writeOctet()

Member Data Documentation

◆ NDPos_Append

◆ NDPos_Clear

◆ NDPos_CurrentIndex

◆ NDPos_CurrentPos

◆ NDPos_CurrentQty

◆ NDPos_Delete

◆ NDPos_DuplicateFrames

◆ NDPos_ExpectedID

◆ NDPos_Filename

◆ NDPos_FileValid

◆ NDPos_IDDifference

◆ NDPos_IDName

◆ NDPos_IDStart

◆ NDPos_MissingFrames

◆ NDPos_Mode

◆ NDPos_Restart

◆ NDPos_Running