Enums for plugin-specific parameters. More...

#include <pcoEdgePlugin.h>

Inheritance diagram for pcoEdgePlugin:

Public Member Functions
	pcoEdgePlugin (const char portName, int queueSize, int blockingCallbacks, const char NDArrayPort, int NDArrayAddr, int priority, int stackSize)
	The constructor for pco Edge plugin. More...

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

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

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

virtual asynStatus	writeFile (NDArray *pArray)
	does nothing. More...

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

int	getIntParam (int param)

Public Member Functions inherited from 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. More...

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

virtual asynStatus	writeNDArray (asynUser pasynUser, void genericPointer)

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

Protected Member Functions
void	sort_lines_A (int width, int height, void adr_out, void adr_in)
	A descrmabling algorithm for the Edge camera. More...

void	sort_lines_B (int width, int height, void adr_out, void adr_in)
	A descrmabling algorithm for the Edge camera. More...

void	sort_lines_C (int width, int height, void adr_out, void adr_in)
	A descrmabling algorithm for the Edge camera. More...

void	sort_lines_D (int width, int height, void adr_out, void adr_in)
	A descrmabling algorithm for the Edge camera. 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)

Protected Attributes
unsigned short *	temp_image

int	arrayDataId

int	uniqueIdId

int	timeStampId

int	nextRecord

int *	pAttributeId

NDAttribute *	pAttribute

char	name [256]

char	description [256]

char	tempString [256]

NDAttrDataType_t	attrDataType

size_t	attrSize

int	numAttributes

int	attrCount

int	sim_first

int	is_descramble

int	is_decompress

int	print_attr

int	is_use_attr

int	is_pr_pco_attr

int	is_enable

int	edge_nd_datasize

int	edge_max_ndbuffers

int	edge_num_ndbuffers

int	edge_max_ndmemory

int	edge_alloc_ndmemory

int	edge_free_ndbuffers

int	edge_est_buffers_left

int	sim_last

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 NDPluginFile
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...

Detailed Description

Enums for plugin-specific parameters.

There are currently no specific parameters for this driver yet. It uses the ADStdDriverParams and NDPluginDriver params.

Constructor & Destructor Documentation

◆ pcoEdgePlugin()

pcoEdgePlugin::pcoEdgePlugin	(	const char *	portName,
		int	queueSize,
		int	blockingCallbacks,
		const char *	NDArrayPort,
		int	NDArrayAddr,
		int	priority,
		int	stackSize
	)

The constructor for pco Edge plugin.

Parameters

portName	asynDriver port name for this plugin, C string.
queueSize	Use a large number, the number of images to be queued up to plugin.
blockingCallbacks	Use 0. 0 means that this plugin won't block the PCO camera driver but runs own thread.
NDArrayPort	asynDriver c string for port name of PCO camera drivber.
NDArrayAddr	Use 0. Only have one address for asyn.
priority	Set to 50.
stackSize	Set to 0.

Member Function Documentation

◆ closeFile()

asynStatus pcoEdgePlugin::closeFile ( )

virtual

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

Implements NDPluginFile.

◆ getIntParam()

int pcoEdgePlugin::getIntParam ( int param )

◆ openFile()

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

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.

Implements NDPluginFile.

◆ processCallbacks()

void pcoEdgePlugin::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.

! where is array_pool set up? need to look at all constructors and mains in older code.

Reimplemented from NDPluginFile.

◆ readFile()

asynStatus pcoEdgePlugin::readFile ( NDArray ** pArray )

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.

Implements NDPluginFile.

◆ sort_lines_A()

void pcoEdgePlugin::sort_lines_A	(	int	width,
		int	height,
		void *	adr_out,
		void *	adr_in
	)

protected

A descrmabling algorithm for the Edge camera.

One of many algs. from PCO inc.

Parameters

width	Widgn of image in pixels
height	Height of image in pixels
adr_out	Pointer to input scrambled image from Edge camera
adr_in	Pointer to memory where new descrambled is written.

◆ sort_lines_B()

void pcoEdgePlugin::sort_lines_B	(	int	width,
		int	height,
		void *	adr_out,
		void *	adr_in
	)

protected

A descrmabling algorithm for the Edge camera.

One of many algs. from PCO inc.

Parameters

width	Widgn of image in pixels
height	Height of image in pixels
adr_out	Pointer to input scrambled image from Edge camera
adr_in	Pointer to memory where new descrambled is written.

◆ sort_lines_C()

void pcoEdgePlugin::sort_lines_C	(	int	width,
		int	height,
		void *	adr_out,
		void *	adr_in
	)

protected

A descrmabling algorithm for the Edge camera.

One of many algs. from PCO inc.

Parameters

width	Widgn of image in pixels
height	Height of image in pixels
adr_out	Pointer to input scrambled image from Edge camera
adr_in	Pointer to memory where new descrambled is written.

◆ sort_lines_D()

void pcoEdgePlugin::sort_lines_D	(	int	width,
		int	height,
		void *	adr_out,
		void *	adr_in
	)

protected

A descrmabling algorithm for the Edge camera.

One of many algs. from PCO inc.

Parameters

width	Widgn of image in pixels
height	Height of image in pixels
adr_out	Pointer to input scrambled image from Edge camera
adr_in	Pointer to memory where new descrambled is written.

◆ writeFile()

asynStatus pcoEdgePlugin::writeFile ( NDArray * pArray )

virtual

does nothing.

Implements NDPluginFile.

Member Data Documentation

◆ arrayDataId

int pcoEdgePlugin::arrayDataId

protected

◆ attrCount

int pcoEdgePlugin::attrCount

protected

◆ attrDataType

NDAttrDataType_t pcoEdgePlugin::attrDataType

protected

◆ attrSize

size_t pcoEdgePlugin::attrSize

protected

◆ description

char pcoEdgePlugin::description[256]

protected

◆ edge_alloc_ndmemory

int pcoEdgePlugin::edge_alloc_ndmemory

protected

◆ edge_est_buffers_left

int pcoEdgePlugin::edge_est_buffers_left

protected

◆ edge_free_ndbuffers

int pcoEdgePlugin::edge_free_ndbuffers

protected

◆ edge_max_ndbuffers

int pcoEdgePlugin::edge_max_ndbuffers

protected

◆ edge_max_ndmemory

int pcoEdgePlugin::edge_max_ndmemory

protected

◆ edge_nd_datasize

int pcoEdgePlugin::edge_nd_datasize

protected

◆ edge_num_ndbuffers

int pcoEdgePlugin::edge_num_ndbuffers

protected

◆ is_decompress

int pcoEdgePlugin::is_decompress

protected

◆ is_descramble

int pcoEdgePlugin::is_descramble

protected

◆ is_enable

int pcoEdgePlugin::is_enable

protected

◆ is_pr_pco_attr

int pcoEdgePlugin::is_pr_pco_attr

protected

◆ is_use_attr

int pcoEdgePlugin::is_use_attr

protected

◆ name

char pcoEdgePlugin::name[256]

protected

◆ nextRecord

int pcoEdgePlugin::nextRecord

protected

◆ numAttributes

int pcoEdgePlugin::numAttributes

protected

◆ pAttribute

NDAttribute* pcoEdgePlugin::pAttribute

protected

◆ pAttributeId

int* pcoEdgePlugin::pAttributeId

protected

◆ print_attr

int pcoEdgePlugin::print_attr

protected

◆ sim_first

int pcoEdgePlugin::sim_first

protected

◆ sim_last

int pcoEdgePlugin::sim_last

protected

◆ temp_image

unsigned short* pcoEdgePlugin::temp_image

protected

◆ tempString

char pcoEdgePlugin::tempString[256]

protected

◆ timeStampId

int pcoEdgePlugin::timeStampId

protected

◆ uniqueIdId

int pcoEdgePlugin::uniqueIdId

protected

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

/home/runner/work/areaDetector/areaDetector/ADPCO/pcoApp/src/pcoEdgePlugin.h
/home/runner/work/areaDetector/areaDetector/ADPCO/pcoApp/src/pcoEdgePlugin.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pcoEdgePlugin()

Member Function Documentation

◆ closeFile()

◆ getIntParam()

◆ openFile()

◆ processCallbacks()

◆ readFile()

◆ sort_lines_A()

◆ sort_lines_B()

◆ sort_lines_C()

◆ sort_lines_D()

◆ writeFile()

Member Data Documentation

◆ arrayDataId

◆ attrCount

◆ attrDataType

◆ attrSize

◆ description

◆ edge_alloc_ndmemory

◆ edge_est_buffers_left

◆ edge_free_ndbuffers

◆ edge_max_ndbuffers

◆ edge_max_ndmemory

◆ edge_nd_datasize

◆ edge_num_ndbuffers

◆ is_decompress

◆ is_descramble

◆ is_enable

◆ is_pr_pco_attr

◆ is_use_attr

◆ name

◆ nextRecord

◆ numAttributes

◆ pAttribute

◆ pAttributeId

◆ print_attr

◆ sim_first

◆ sim_last

◆ temp_image

◆ tempString

◆ timeStampId

◆ uniqueIdId