#include <ADnED.h>

Inheritance diagram for ADnED:

Public Member Functions
	ADnED (const char *portName, int maxBuffers, size_t maxMemory, int debug)
	Constructor.

virtual	~ADnED ()
	Destructor.

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Reimplementing this function from ADDriver to deal with integer values.

virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Reimplementing this function from ADDriver to deal with floating point values.

virtual asynStatus	writeOctet (asynUser pasynUser, const char value, size_t nChars, size_t *nActual)
	Reimplementing this function from asynNDArrayDriver to deal with strings.

virtual void	report (FILE *fp, int details)
	Report status of the driver.

void	eventTask (void)
	Event readout task.

void	frameTask (void)
	Frame readout task.

void	eventHandler (std::tr1::shared_ptr< epics::pvData::PVStructure > const &pv_struct, epicsUInt32 channelID)
	Event handler callback for monitor.

asynStatus	allocArray (void)
	Allocate local storage for event handler.

asynStatus	clearParams (void)
	Clear parameters and data members on a acqusition start.

Public Member Functions inherited from ADDriver
	ADDriver (const char *portName, int maxAddr, int numParams, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
	All of the arguments are simply passed to the constructor for the asynNDArrayDriver base class, except numParams.

virtual asynStatus	connect (asynUser *pasynUser)
	Connects driver to device; This method is called when the driver's pasynCommon->connect() function is called.

virtual void	setShutter (int open)
	Set the shutter position.

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.

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.

virtual asynStatus	writeGenericPointer (asynUser pasynUser, void genericPointer)
	This method currently does nothing, but it should be implemented in this base class.

virtual asynStatus	setIntegerParam (int index, int value)
	Sets the value for an integer in the parameter library.

virtual asynStatus	setIntegerParam (int list, int index, int value)
	Sets the value for an integer in the parameter library.

virtual asynStatus	createFilePath (const char *path, int pathDepth)
	Function to create a directory path for a file.

virtual asynStatus	checkPath ()
	Checks whether the directory specified NDFilePath parameter exists.

virtual bool	checkPath (std::string &filePath)
	Checks whether the directory specified exists.

virtual asynStatus	createFileName (int maxChars, char *fullFileName)
	Build a file name from component parts.

virtual asynStatus	createFileName (int maxChars, char filePath, char fileName)
	Build a file name from component parts.

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.

virtual asynStatus	getAttributes (NDAttributeList *pAttributeList)
	Get the current values of attributes from this driver and appends them to an output attribute list.

virtual void	updateTimeStamps (NDArray *pArray)

asynStatus	incrementQueuedArrayCount ()

asynStatus	decrementQueuedArrayCount ()

int	getQueuedArrayCount ()

void	updateQueuedArrayCount ()

Static Public Member Functions
static asynStatus	createFactory ()
	Class function to create a PVAccess client factory.

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

Protected Attributes inherited from ADDriver
int	ADGain

int	ADBinX

int	ADBinY

int	ADMinX

int	ADMinY

int	ADSizeX

int	ADSizeY

int	ADMaxSizeX

int	ADMaxSizeY

int	ADReverseX

int	ADReverseY

int	ADFrameType

int	ADImageMode

int	ADNumExposures

int	ADNumExposuresCounter

int	ADNumImages

int	ADNumImagesCounter

int	ADAcquireTime

int	ADAcquirePeriod

int	ADTimeRemaining

int	ADStatus

int	ADTriggerMode

int	ADShutterControl

int	ADShutterControlEPICS

int	ADShutterStatus

int	ADShutterMode

int	ADShutterOpenDelay

int	ADShutterCloseDelay

int	ADTemperature

int	ADTemperatureActual

int	ADReadStatus

int	ADStatusMessage

int	ADStringToServer

int	ADStringFromServer

bool	deviceIsReachable

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.

class NDAttributeList *	pAttributeList
	An NDAttributeList object used to obtain the current values of a set of attributes.

int	threadStackSize_

int	threadPriority_

Constructor & Destructor Documentation

◆ ADnED()

ADnED::ADnED	(	const char *	portName,
		int	maxBuffers,
		size_t	maxMemory,
		int	debug
	)

Constructor.

This must be called in the Epics IOC startup file.

Parameters

portName	The Asyn port name to use
maxBuffers	Used by asynPortDriver (set to -1 for unlimited)
maxMemory	Used by asynPortDriver (set to -1 for unlimited)
debug	This debug flag for the driver.

◆ ~ADnED()

ADnED::~ADnED ( )

virtual

Destructor.

Should never get here.

Member Function Documentation

◆ allocArray()

asynStatus ADnED::allocArray ( void )

Allocate local storage for event handler.

This is only done when any of the detector sizes or TOF range has changed. It then publishes the start and end points of the detector and TOF data in the NDArray object.

◆ clearParams()

asynStatus ADnED::clearParams ( void )

Clear parameters and data members on a acqusition start.

◆ createFactory()

asynStatus ADnED::createFactory ( )

static

Class function to create a PVAccess client factory.

◆ eventHandler()

void ADnED::eventHandler	(	std::tr1::shared_ptr< epics::pvData::PVStructure > const &	pv_struct,
		epicsUInt32	channelID
	)

Event handler callback for monitor.

◆ eventTask()

void ADnED::eventTask ( void )

Event readout task.

◆ frameTask()

void ADnED::frameTask ( void )

Frame readout task.

◆ report()

void ADnED::report	(	FILE *	fp,
		int	details
	)

virtual

Report status of the driver.

Prints details about the detector in us if details>0. It then calls the ADDriver::report() method.

Parameters

[in]	fp	File pointed passed by caller where the output is written to.
[in]	details	Controls the level of detail in the report.

Reimplemented from asynNDArrayDriver.

◆ writeFloat64()

asynStatus ADnED::writeFloat64	(	asynUser *	pasynUser,
		epicsFloat64	value
	)

virtual

Reimplementing this function from ADDriver to deal with floating point values.

◆ writeInt32()

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

virtual

Reimplementing this function from ADDriver to deal with integer values.

Reimplemented from ADDriver.

◆ writeOctet()

asynStatus ADnED::writeOctet	(	asynUser *	pasynUser,
		const char *	value,
		size_t	nChars,
		size_t *	nActual
	)

virtual

Reimplementing this function from asynNDArrayDriver to deal with strings.

Reimplemented from asynNDArrayDriver.

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

/home/runner/work/areaDetector/areaDetector/ADnED/ADnEDApp/src/ADnED.h
/home/runner/work/areaDetector/areaDetector/ADnED/ADnEDApp/src/ADnED.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ADnED()

◆ ~ADnED()

Member Function Documentation

◆ allocArray()

◆ clearParams()

◆ createFactory()

◆ eventHandler()

◆ eventTask()

◆ frameTask()

◆ report()

◆ writeFloat64()

◆ writeInt32()

◆ writeOctet()