Aravis GigE detector driver. More...

Inheritance diagram for aravisCamera:

Public Member Functions
	aravisCamera (const char portName, const char cameraName, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for aravisCamera; 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 asynStatus	drvUserCreate (asynUser pasynUser, const char drvInfo, const char *pptypeName, size_t psize)

virtual asynStatus	readEnum (asynUser pasynUser, char strings[], int values[], int severities[], size_t nElements, size_t *nIn)

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

void	run ()
	Check what event we have, and deal with new frames. 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...

virtual void	setShutter (int open)
	Set the shutter position. 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	readInt32 (asynUser pasynUser, epicsInt32 value)

virtual asynStatus	readFloat64 (asynUser pasynUser, epicsFloat64 value)

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

asynStatus	incrementQueuedArrayCount ()

asynStatus	decrementQueuedArrayCount ()

int	getQueuedArrayCount ()

void	updateQueuedArrayCount ()

Public Attributes
epicsMessageQueueId	msgQId

ArvCamera *	camera
	Used by epicsAtExit. More...

int	connectionValid
	Used by connection lost callback. More...

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

Protected Attributes
int	AravisCompleted

int	AravisFailures

int	AravisUnderruns

int	AravisFrameRetention

int	AravisMissingPkts

int	AravisPktResend

int	AravisPktTimeout

int	AravisResentPkts

int	AravisLeftShift

int	AravisConnection

int	AravisGetFeatures

int	AravisHWImageMode

int	AravisReset

int	features [NFEATURES]

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	NDFileCapture

int	NDFileDeleteDriverFile

int	NDFileLazyOpen

int	NDFileCreateDir

int	NDFileTempSuffix

int	NDAttributesFile

int	NDAttributesStatus

int	NDAttributesMacros

int	NDArrayData

int	NDArrayCallbacks

int	NDPoolMaxBuffers

int	NDPoolAllocBuffers

int	NDPoolFreeBuffers

int	NDPoolMaxMemory

int	NDPoolUsedMemory

int	NDPoolEmptyFreeList

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

Aravis GigE detector driver.

Constructor & Destructor Documentation

◆ aravisCamera()

aravisCamera::aravisCamera	(	const char *	portName,
		const char *	cameraName,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

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

After calling the base class constructor this method creates a thread to compute the GigE 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]	cameraName	The name of the camera, <vendor>-<serial#>, as returned by arv-show-devices
[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

◆ drvUserCreate()

asynStatus aravisCamera::drvUserCreate	(	asynUser *	pasynUser,
		const char *	drvInfo,
		const char **	pptypeName,
		size_t *	psize
	)

virtual

◆ readEnum()

asynStatus aravisCamera::readEnum	(	asynUser *	pasynUser,
		char *	strings[],
		int	values[],
		int	severities[],
		size_t	nElements,
		size_t *	nIn
	)

virtual

◆ report()

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

◆ run()

void aravisCamera::run ( void )

Check what event we have, and deal with new frames.

this->camera exists, lock not taken

◆ writeFloat64()

asynStatus aravisCamera::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 aravisCamera::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

◆ AravisCompleted

int aravisCamera::AravisCompleted

protected

◆ AravisConnection

int aravisCamera::AravisConnection

protected

◆ AravisFailures

int aravisCamera::AravisFailures

protected

◆ AravisFrameRetention

int aravisCamera::AravisFrameRetention

protected

◆ AravisGetFeatures

int aravisCamera::AravisGetFeatures

protected

◆ AravisHWImageMode

int aravisCamera::AravisHWImageMode

protected

◆ AravisLeftShift

int aravisCamera::AravisLeftShift

protected

◆ AravisMissingPkts

int aravisCamera::AravisMissingPkts

protected

◆ AravisPktResend

int aravisCamera::AravisPktResend

protected

◆ AravisPktTimeout

int aravisCamera::AravisPktTimeout

protected

◆ AravisResentPkts

int aravisCamera::AravisResentPkts

protected

◆ AravisReset

int aravisCamera::AravisReset

protected

◆ AravisUnderruns

int aravisCamera::AravisUnderruns

protected

◆ camera

ArvCamera* aravisCamera::camera

Used by epicsAtExit.

◆ connectionValid

int aravisCamera::connectionValid

Used by connection lost callback.

◆ features

int aravisCamera::features[NFEATURES]

protected

◆ msgQId

epicsMessageQueueId aravisCamera::msgQId

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

/home/travis/build/areaDetector/areaDetector/aravisGigE/aravisGigEApp/src/aravisCamera.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ aravisCamera()

Member Function Documentation

◆ drvUserCreate()

◆ readEnum()

◆ report()

◆ run()

◆ writeFloat64()

◆ writeInt32()

Member Data Documentation

◆ AravisCompleted

◆ AravisConnection

◆ AravisFailures

◆ AravisFrameRetention

◆ AravisGetFeatures

◆ AravisHWImageMode

◆ AravisLeftShift

◆ AravisMissingPkts

◆ AravisPktResend

◆ AravisPktTimeout

◆ AravisResentPkts

◆ AravisReset

◆ AravisUnderruns

◆ camera

◆ connectionValid

◆ features

◆ msgQId