simDetector Class Reference

Simulation detector driver; demonstrates most of the features that areaDetector drivers can support. More...

#include <simDetector.h>

Inheritance diagram for simDetector:

Public Member Functions
	simDetector (const char *portName, int maxSizeX, int maxSizeY, NDDataType_t dataType, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for simDetector; most parameters are simply passed to ADDriver::ADDriver. More...
virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Called when asyn clients call pasynInt32->write(). More...
virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Called when asyn clients call pasynFloat64->write(). More...
virtual void	setShutter (int open)
	Controls the shutter. More...
virtual void	report (FILE *fp, int details)
	Report status of the driver. More...
void	simTask ()
	Should be private, but gets called from C, so must be public. More...
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. More...
virtual asynStatus	connect (asynUser *pasynUser)
	Connects driver to device; This method is called when the driver's pasynCommon->connect() function is called. 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	writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual)
	Called when asyn clients call pasynOctet->write(). More...
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 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	SimGainX
int	SimGainY
int	SimGainRed
int	SimGainGreen
int	SimGainBlue
int	simOffset
int	SimNoise
int	SimResetImage
int	SimMode
int	SimPeakStartX
int	SimPeakStartY
int	SimPeakWidthX
int	SimPeakWidthY
int	SimPeakNumX
int	SimPeakNumY
int	SimPeakStepX
int	SimPeakStepY
int	SimPeakHeightVariation
int	SimOffset
int	SimXSineOperation
int	SimXSine1Amplitude
int	SimXSine1Frequency
int	SimXSine1Phase
int	SimXSine2Amplitude
int	SimXSine2Frequency
int	SimXSine2Phase
int	SimYSineOperation
int	SimYSine1Amplitude
int	SimYSine1Frequency
int	SimYSine1Phase
int	SimYSine2Amplitude
int	SimYSine2Frequency
int	SimYSine2Phase
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. 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...

Detailed Description

Simulation detector driver; demonstrates most of the features that areaDetector drivers can support.

Constructor & Destructor Documentation

simDetector()

simDetector::simDetector	(	const char *	portName,
		int	maxSizeX,
		int	maxSizeY,
		NDDataType_t	dataType,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

Constructor for simDetector; most parameters are simply passed to ADDriver::ADDriver.

After calling the base class constructor this method creates a thread to compute the simulated detector data, and sets reasonable default values for parameters defined in this class, asynNDArrayDriver and ADDriver.

Parameters

[in]	portName	The name of the asyn port driver to be created.
[in]	maxSizeX	The maximum X dimension of the images that this driver can create.
[in]	maxSizeY	The maximum Y dimension of the images that this driver can create.
[in]	dataType	The initial data type (NDDataType_t) of the images that this driver will create.
[in]	maxBuffers	The 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]	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.

Member Function Documentation

report()

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

virtual

Report status of the driver.

Prints details about the driver 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	If >0 then driver details are printed.

Reimplemented from asynNDArrayDriver.

setShutter()

void simDetector::setShutter ( int  open )

virtual

Controls the shutter.

Reimplemented from ADDriver.

simTask()

void simDetector::simTask

(

)

Should be private, but gets called from C, so must be public.

This thread calls computeImage to compute new image data and does the callbacks to send it to higher layers.

It implements the logic for single, multiple or continuous acquisition.

writeFloat64()

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

virtual

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

This function performs actions for some parameters, including ADAcquireTime, ADGain, etc. 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.

writeInt32()

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

virtual

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

This function performs actions for some parameters, including ADAcquire, ADColorMode, etc. 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 ADDriver.

Member Data Documentation

SimGainBlue

int simDetector::SimGainBlue

protected

SimGainGreen

int simDetector::SimGainGreen

protected

SimGainRed

int simDetector::SimGainRed

protected

SimGainX

int simDetector::SimGainX

protected

SimGainY

int simDetector::SimGainY

protected

SimMode

int simDetector::SimMode

protected

SimNoise

int simDetector::SimNoise

protected

simOffset

int simDetector::simOffset

protected

SimOffset

int simDetector::SimOffset

protected

SimPeakHeightVariation

int simDetector::SimPeakHeightVariation

protected

SimPeakNumX

int simDetector::SimPeakNumX

protected

SimPeakNumY

int simDetector::SimPeakNumY

protected

SimPeakStartX

int simDetector::SimPeakStartX

protected

SimPeakStartY

int simDetector::SimPeakStartY

protected

SimPeakStepX

int simDetector::SimPeakStepX

protected

SimPeakStepY

int simDetector::SimPeakStepY

protected

SimPeakWidthX

int simDetector::SimPeakWidthX

protected

SimPeakWidthY

int simDetector::SimPeakWidthY

protected

SimResetImage

int simDetector::SimResetImage

protected

SimXSine1Amplitude

int simDetector::SimXSine1Amplitude

protected

SimXSine1Frequency

int simDetector::SimXSine1Frequency

protected

SimXSine1Phase

int simDetector::SimXSine1Phase

protected

SimXSine2Amplitude

int simDetector::SimXSine2Amplitude

protected

SimXSine2Frequency

int simDetector::SimXSine2Frequency

protected

SimXSine2Phase

int simDetector::SimXSine2Phase

protected

SimXSineOperation

int simDetector::SimXSineOperation

protected

SimYSine1Amplitude

int simDetector::SimYSine1Amplitude

protected

SimYSine1Frequency

int simDetector::SimYSine1Frequency

protected

SimYSine1Phase

int simDetector::SimYSine1Phase

protected

SimYSine2Amplitude

int simDetector::SimYSine2Amplitude

protected

SimYSine2Frequency

int simDetector::SimYSine2Frequency

protected

SimYSine2Phase

int simDetector::SimYSine2Phase

protected

SimYSineOperation

int simDetector::SimYSineOperation

protected

---

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

• /home/runner/work/areaDetector/areaDetector/ADSimDetector/simDetectorApp/src/simDetector.h
• /home/runner/work/areaDetector/areaDetector/ADSimDetector/simDetectorApp/src/simDetector.cpp