Base class for NDArray file writing plugins; actual file writing plugins inherit from this class. More...

#include <NDPluginFile.h>

Inheritance diagram for NDPluginFile:

Public Member Functions
	NDPluginFile (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 NDPluginFile; all parameters are simply passed to NDPluginDriver::NDPluginDriver. More...

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

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Called when asyn clients call pasynInt32->write(). More...

virtual asynStatus	writeNDArray (asynUser pasynUser, void genericPointer)

virtual asynStatus	openFile (const char fileName, NDFileOpenMode_t openMode, NDArray pArray)=0
	Open a file; pure virtual function that must be implemented by derived classes. More...

virtual asynStatus	readFile (NDArray **pArray)=0
	Read NDArray data from a file; pure virtual function that must be implemented by derived classes. More...

virtual asynStatus	writeFile (NDArray *pArray)=0
	Write NDArray data to a file; pure virtual function that must be implemented by derived classes. More...

virtual asynStatus	closeFile ()=0
	Close the file opened with NDPluginFile::openFile; pure virtual function that must be implemented by derived classes. 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	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 ()

Public Attributes
int	supportsMultipleArrays
	Derived classes must set this flag to 0/1 if they cannot/can write multiple NDArrays to a single file. More...

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

Additional Inherited Members
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 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_

Detailed Description

Base class for NDArray file writing plugins; actual file writing plugins inherit from this class.

This class handles the logic of single file per image, capture into buffer or streaming multiple images to a single file. Derived classes must implement the 4 pure virtual functions: openFile, readFile, writeFile and closeFile.

Constructor & Destructor Documentation

◆ NDPluginFile()

NDPluginFile::NDPluginFile	(	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 NDPluginFile; all parameters are simply passed to NDPluginDriver::NDPluginDriver.

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]	maxAddr	The maximum number of asyn addr addresses this driver supports. 1 is minimum.
[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]	interfaceMask	Bit mask defining the asyn interfaces that this driver supports.
[in]	interruptMask	Bit mask definining the asyn interfaces that can generate interrupts (callbacks)
[in]	asynFlags	Flags when creating the asyn port driver; includes ASYN_CANBLOCK and ASYN_MULTIDEVICE.
[in]	autoConnect	The autoConnect flag for the asyn port driver.
[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.
[in]	maxThreads	The maximum number of threads this driver is allowed to use. If 0 then 1 will be used.
[in]	compressionAware	true if this file plugin can handle compressed NDArrays.

Member Function Documentation

◆ closeFile()

virtual asynStatus NDPluginFile::closeFile ( )

pure virtual

Close the file opened with NDPluginFile::openFile; pure virtual function that must be implemented by derived classes.

Implemented in ffmpegFile, pcoEdgePlugin, NDFileTIFF, NDFileNull, NDFileNexus, NDFileNetCDF, NDFileMagick, NDFileJPEG, and NDFileHDF5.

◆ openFile()

virtual asynStatus NDPluginFile::openFile	(	const char *	fileName,
		NDFileOpenMode_t	openMode,
		NDArray *	pArray
	)

pure virtual

Open a file; pure virtual function that must be implemented by derived classes.

Parameters

[in]	fileName	Absolute path name of the file to open.
[in]	openMode	Bit mask with one of the access mode bits NDFileModeRead, NDFileModeWrite. NDFileModeAppend. May also have the bit NDFileModeMultiple set if the file is to be opened to write or read multiple NDArrays into a single file.
[in]	pArray	Pointer to an NDArray; this array does not contain data to be written or read. Rather it can be used to determine the header information and data structure for the file. It is guaranteed that NDArrays pass to NDPluginFile::writeFile or NDPluginFile::readFile will have the same data type, data dimensions and attributes as this array.

Implemented in ffmpegFile, pcoEdgePlugin, NDFileTIFF, NDFileNull, NDFileNexus, NDFileNetCDF, NDFileMagick, NDFileJPEG, and NDFileHDF5.

◆ processCallbacks()

void NDPluginFile::processCallbacks ( NDArray * pArray )

virtual

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

Saves a single file if NDFileWriteMode=NDFileModeSingle and NDAutoSave=1. Stores array in a capture buffer if NDFileWriteMode=NDFileModeCapture and NDFileCapture=1. Appends data to an open file if NDFileWriteMode=NDFileModeStream and NDFileCapture=1. In capture or stream mode if the desired number of arrays has been saved (NDFileNumCaptured=NDFileNumCapture) then it stops capture or streaming.

Parameters

[in] pArray The NDArray from the callback.

Implements NDPluginDriver.

Reimplemented in pcoEdgePlugin.

◆ readFile()

virtual asynStatus NDPluginFile::readFile ( NDArray ** pArray )

pure virtual

Read NDArray data from a file; pure virtual function that must be implemented by derived classes.

Parameters

[in] pArray Pointer to the address of an NDArray to read the data into.

Implemented in ffmpegFile, pcoEdgePlugin, NDFileTIFF, NDFileNull, NDFileNexus, NDFileNetCDF, NDFileMagick, NDFileJPEG, and NDFileHDF5.

◆ writeFile()

virtual asynStatus NDPluginFile::writeFile ( NDArray * pArray )

pure virtual

Write NDArray data to a file; pure virtual function that must be implemented by derived classes.

Parameters

[in] pArray Pointer to an NDArray to write to the file. This function can be called multiple times between the call to openFile and closeFile if the class set supportsMultipleArrays=1 and NDFileModeMultiple was set in openMode in the call to NDPluginFile::openFile.

Implemented in ffmpegFile, pcoEdgePlugin, NDFileTIFF, NDFileNull, NDFileNexus, NDFileNetCDF, NDFileMagick, NDFileJPEG, and NDFileHDF5.

◆ writeInt32()

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

virtual

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

This function performs actions for some parameters, including NDReadFile, NDWriteFile and NDFileCapture. For other parameters it calls NDPluginDriver::writeInt32 to see if that method understands the parameter. 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	Value to write.

Reimplemented from NDPluginDriver.

Reimplemented in NDFileHDF5.

◆ writeNDArray()

asynStatus NDPluginFile::writeNDArray	(	asynUser *	pasynUser,
		void *	genericPointer
	)

virtual

Member Data Documentation

◆ supportsMultipleArrays

int NDPluginFile::supportsMultipleArrays

Derived classes must set this flag to 0/1 if they cannot/can write multiple NDArrays to a single file.

Used in capture and stream modes.

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NDPluginFile()

Member Function Documentation

◆ closeFile()

◆ openFile()

◆ processCallbacks()

◆ readFile()

◆ writeFile()

◆ writeInt32()

◆ writeNDArray()

Member Data Documentation

◆ supportsMultipleArrays