prosilica Class Reference

Driver for Prosilica GigE and CameraLink cameras using their PvApi library. More...

Inheritance diagram for prosilica:

Public Member Functions
	prosilica (const char *portName, const char *cameraId, int maxBuffers, size_t maxMemory, int priority, int stackSize, int maxPvAPIFrames)
	Constructor for Prosilica driver; most parameters are simply passed to ADDriver::ADDriver. More...
	~prosilica ()
virtual asynStatus	connect (asynUser *pasynUser)
	Connects driver to device; This method is called when the driver's pasynCommon->connect() function is called. More...
virtual asynStatus	disconnect (asynUser *pasynUser)
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...
void	report (FILE *fp, int details)
	Report status of the driver. More...
void	frameCallback (tPvFrame *pFrame)
	This function gets called in a thread from the PvApi library when a new frame arrives. 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 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	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 ()

Static Public Member Functions
static void PVDECL	cameraLinkCallback (void *Context, tPvInterface Interface, tPvLinkEvent Event, unsigned long UniqueId)
static void	shutdown (void *arg)

Protected Attributes
int	PSReadStatistics
int	PSBayerConvert
int	PSGainMode
int	PSExposureMode
int	PSDriverType
int	PSFilterVersion
int	PSTimestampType
int	PSResetTimer
int	PSFrameRate
int	PSByteRate
int	PSPacketSize
int	PSFramesCompleted
int	PSFramesDropped
int	PSPacketsErroneous
int	PSPacketsMissed
int	PSPacketsReceived
int	PSPacketsRequested
int	PSPacketsResent
int	PSBadFrameCounter
int	PSTriggerDelay
int	PSTriggerEvent
int	PSTriggerOverlap
int	PSTriggerSoftware
int	PSSyncIn1Level
int	PSSyncIn2Level
int	PSSyncOut1Mode
int	PSSyncOut1Level
int	PSSyncOut1Invert
int	PSSyncOut2Mode
int	PSSyncOut2Level
int	PSSyncOut2Invert
int	PSSyncOut3Mode
int	PSSyncOut3Level
int	PSSyncOut3Invert
int	PSStrobe1Mode
int	PSStrobe1Delay
int	PSStrobe1CtlDuration
int	PSStrobe1Duration
int	PSTemperatureMainboard
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

Driver for Prosilica GigE and CameraLink cameras using their PvApi library.

Constructor & Destructor Documentation

prosilica()

prosilica::prosilica	(	const char *	portName,
		const char *	cameraId,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize,
		int	maxPvAPIFrames
	)

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

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

Parameters

[in]	portName	The name of the asyn port driver to be created.
[in]	cameraId	The uniqueId, IP address or IP DNS name of the camera to be connected to this driver.
[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.
[in]	maxPvAPIFrames	The number of frame buffers to use in the PvAPI library driver. Default=MAX_PVAPI_FRAMES=2.

~prosilica()

prosilica::~prosilica

(

)

Member Function Documentation

cameraLinkCallback()

void PVDECL prosilica::cameraLinkCallback ( void *  Context, tPvInterface  Interface, tPvLinkEvent  Event, unsigned long  UniqueId  )

static

connect()

asynStatus prosilica::connect ( asynUser *  pasynUser )

virtual

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

It uses the class variable deviceIsReachable to determine whether to call asynPortDriver::connect(), which in turn calls pasynManager::exceptionConnect() to signal that the driver is connected to the underlying hardware. Derived classes can override this method if they need to handle connect() calls in a more complex way. For example, with a network camera that can be temporarily unreachable the driver could attempt to connect to the camera each time that connect() is called.

Parameters

[in]

pasynUser

The pasynUser structure which contains information about the port and address

Reimplemented from ADDriver.

disconnect()

asynStatus prosilica::disconnect ( asynUser *  pasynUser )

virtual

frameCallback()

void prosilica::frameCallback

(

tPvFrame *

pFrame

)

This function gets called in a thread from the PvApi library when a new frame arrives.

report()

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

shutdown()

void prosilica::shutdown ( void *  arg )

static

writeFloat64()

asynStatus prosilica::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 prosilica::writeInt32 ( asynUser *  pasynUser, epicsInt32  value  )

virtual

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

This function performs actions for some parameters, including ADAcquire, ADBinX, 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

PSBadFrameCounter

int prosilica::PSBadFrameCounter

protected

PSBayerConvert

int prosilica::PSBayerConvert

protected

PSByteRate

int prosilica::PSByteRate

protected

PSDriverType

int prosilica::PSDriverType

protected

PSExposureMode

int prosilica::PSExposureMode

protected

PSFilterVersion

int prosilica::PSFilterVersion

protected

PSFrameRate

int prosilica::PSFrameRate

protected

PSFramesCompleted

int prosilica::PSFramesCompleted

protected

PSFramesDropped

int prosilica::PSFramesDropped

protected

PSGainMode

int prosilica::PSGainMode

protected

PSPacketsErroneous

int prosilica::PSPacketsErroneous

protected

PSPacketSize

int prosilica::PSPacketSize

protected

PSPacketsMissed

int prosilica::PSPacketsMissed

protected

PSPacketsReceived

int prosilica::PSPacketsReceived

protected

PSPacketsRequested

int prosilica::PSPacketsRequested

protected

PSPacketsResent

int prosilica::PSPacketsResent

protected

PSReadStatistics

int prosilica::PSReadStatistics

protected

PSResetTimer

int prosilica::PSResetTimer

protected

PSStrobe1CtlDuration

int prosilica::PSStrobe1CtlDuration

protected

PSStrobe1Delay

int prosilica::PSStrobe1Delay

protected

PSStrobe1Duration

int prosilica::PSStrobe1Duration

protected

PSStrobe1Mode

int prosilica::PSStrobe1Mode

protected

PSSyncIn1Level

int prosilica::PSSyncIn1Level

protected

PSSyncIn2Level

int prosilica::PSSyncIn2Level

protected

PSSyncOut1Invert

int prosilica::PSSyncOut1Invert

protected

PSSyncOut1Level

int prosilica::PSSyncOut1Level

protected

PSSyncOut1Mode

int prosilica::PSSyncOut1Mode

protected

PSSyncOut2Invert

int prosilica::PSSyncOut2Invert

protected

PSSyncOut2Level

int prosilica::PSSyncOut2Level

protected

PSSyncOut2Mode

int prosilica::PSSyncOut2Mode

protected

PSSyncOut3Invert

int prosilica::PSSyncOut3Invert

protected

PSSyncOut3Level

int prosilica::PSSyncOut3Level

protected

PSSyncOut3Mode

int prosilica::PSSyncOut3Mode

protected

PSTemperatureMainboard

int prosilica::PSTemperatureMainboard

protected

PSTimestampType

int prosilica::PSTimestampType

protected

PSTriggerDelay

int prosilica::PSTriggerDelay

protected

PSTriggerEvent

int prosilica::PSTriggerEvent

protected

PSTriggerOverlap

int prosilica::PSTriggerOverlap

protected

PSTriggerSoftware

int prosilica::PSTriggerSoftware

protected

---

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

• /home/runner/work/areaDetector/areaDetector/ADProsilica/prosilicaApp/src/prosilica.cpp