Main driver class inherited from areaDetectors ADDriver class. More...

Inheritance diagram for FirewireWinDCAM:

Public Member Functions
	FirewireWinDCAM (const char portName, const char camid, int maxBuffers, size_t maxMemory, int priority, int stackSize)
	Constructor for the FirewireWinDCAM class Initialises the camera object by setting all the default parameters and initializing the camera hardware with it. More...

virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Sets an int32 parameter. More...

virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Sets an float64 parameter. More...

void	report (FILE *fp, int details)
	Print out a report; calls ADDriver::report to get base class report as well. More...

void	imageGrabTask ()
	This should be private but is called from C callback function, 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...

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

Protected Attributes
int	FDC_feat_val

int	FDC_feat_val_max

int	FDC_feat_val_min
	Feature maximum boundry value (int32 read) addr: 0-17. More...

int	FDC_feat_val_abs
	Feature minimum boundry value (int32 read) addr: 0-17. More...

int	FDC_feat_val_abs_max
	Feature absolute value (float64 read/write) addr: 0-17. More...

int	FDC_feat_val_abs_min
	Feature absolute maximum boundry value (float64 read) addr: 0-17. More...

int	FDC_feat_mode
	Feature absolute minimum boundry value (float64 read) addr: 0-17. More...

int	FDC_feat_available
	Feature control mode: 0:manual or 1:automatic (camera controlled) (int32 read/write) More...

int	FDC_feat_absolute
	Is a given featurea available in the camera 1=available 0=not available (int32, read) More...

int	FDC_format
	Feature has absolute (floating point) controls available 1=available 0=not available (int32 read) More...

int	FDC_mode
	Set and read back the video format (int32 (enums) read/write) More...

int	FDC_framerate
	Set and read back the video mode (int32 (enums) read/write) More...

int	FDC_colorcode
	Set and read back the frame rate (int32 (enums) read/write) More...

int	FDC_valid_format
	Set and read back the color code (int32 (enums) read/write) More...

int	FDC_valid_mode
	Read back the valid video formats (octet, read) More...

int	FDC_valid_framerate
	Read back the valid video modes (octet, read) More...

int	FDC_valid_colorcode
	Read back the valid frame rates (octet, read) More...

int	FDC_has_format
	Read back the valid color codes (octet, read) More...

int	FDC_has_mode
	Read back whether video format is supported (int32, read) More...

int	FDC_has_framerate
	Read back whether video mode is supported (int32, read) More...

int	FDC_has_colorcode
	Read back whether video framerate is supported (int32, read) More...

int	FDC_current_format
	Read back whether color code is supported (int32, read) More...

int	FDC_current_mode
	Read back the current video format (octet, read) More...

int	FDC_current_framerate
	Read back the current video mode (octet, read) More...

int	FDC_current_colorcode
	Read back the current frame rate (octet, read) More...

int	FDC_readout_time
	Read back the current color mcde (octet, read) More...

int	FDC_dropped_frames
	Readout time (float64, read/write) More...

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

Main driver class inherited from areaDetectors ADDriver class.

One instance of this class will control one firewire camera on the bus.

Constructor & Destructor Documentation

◆ FirewireWinDCAM()

FirewireWinDCAM::FirewireWinDCAM	(	const char *	portName,
		const char *	camid,
		int	maxBuffers,
		size_t	maxMemory,
		int	priority,
		int	stackSize
	)

Constructor for the FirewireWinDCAM class Initialises the camera object by setting all the default parameters and initializing the camera hardware with it.

This function also reads out the current settings of the camera and prints out a selection of parameters to the shell.

Parameters

[in]	portName	Asyn port name to assign to the camera driver.
[in]	camid	The camera ID or serial number in a hexadecimal string. Lower case and upper case letters can be used. This is used to identify a specific camera on the bus. For instance: "0x00b09d01007139d0". If this parameter is empty ("") then the first camera found on the Firewire bus will be used.
[in]	maxBuffers	Maxiumum number of NDArray objects (image buffers) this driver is allowed to allocate. This driver requires 2 buffers, and each queue element in a plugin can require one buffer which will all need to be added up in this parameter. Use -1 for unlimited.
[in]	maxMemory	Maximum memory (in bytes) that this driver is allowed to allocate. So if max. size = 1024x768 (8bpp) and maxBuffers is, say 14. maxMemory = 1024x768x14 = 11010048 bytes (~11MB). Use -1 for unlimited.
[in]	priority	The EPICS thread priority for this asyn port driver. 0=use asyn default.
[in]	stackSize	The size of the stack for the asyn port thread. 0=use asyn default.

Member Function Documentation

◆ imageGrabTask()

void FirewireWinDCAM::imageGrabTask ( )

This should be private but is called from C callback function, must be public.

Task to grab images off the camera and send them up to areaDetector.

◆ report()

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

virtual

Print out a report; calls ADDriver::report to get base class report as well.

Parameters

[in]	fp	File pointer to write output to
[in]	details	Level of detail desired. If >1 prints information about supported video formats and modes, etc.

Reimplemented from asynNDArrayDriver.

◆ writeFloat64()

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

virtual

Sets an float64 parameter.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	value	The value for this parameter

Takes action if the function code requires it. The FDC_feat_val_abs function code makes calls to the Firewire library from this function.

◆ writeInt32()

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

virtual

Sets an int32 parameter.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	value	The value for this parameter

Takes action if the function code requires it. ADAcquire, ADSizeX, and many other function codes make calls to the Firewire library from this function.

Reimplemented from ADDriver.

Member Data Documentation

◆ FDC_colorcode

int FirewireWinDCAM::FDC_colorcode

protected

Set and read back the frame rate (int32 (enums) read/write)

◆ FDC_current_colorcode

int FirewireWinDCAM::FDC_current_colorcode

protected

Read back the current frame rate (octet, read)

◆ FDC_current_format

int FirewireWinDCAM::FDC_current_format

protected

Read back whether color code is supported (int32, read)

◆ FDC_current_framerate

int FirewireWinDCAM::FDC_current_framerate

protected

Read back the current video mode (octet, read)

◆ FDC_current_mode

int FirewireWinDCAM::FDC_current_mode

protected

Read back the current video format (octet, read)

◆ FDC_dropped_frames

int FirewireWinDCAM::FDC_dropped_frames

protected

Readout time (float64, read/write)

◆ FDC_feat_absolute

int FirewireWinDCAM::FDC_feat_absolute

protected

Is a given featurea available in the camera 1=available 0=not available (int32, read)

◆ FDC_feat_available

int FirewireWinDCAM::FDC_feat_available

protected

Feature control mode: 0:manual or 1:automatic (camera controlled) (int32 read/write)

◆ FDC_feat_mode

int FirewireWinDCAM::FDC_feat_mode

protected

Feature absolute minimum boundry value (float64 read) addr: 0-17.

◆ FDC_feat_val

int FirewireWinDCAM::FDC_feat_val

protected

◆ FDC_feat_val_abs

int FirewireWinDCAM::FDC_feat_val_abs

protected

Feature minimum boundry value (int32 read) addr: 0-17.

◆ FDC_feat_val_abs_max

int FirewireWinDCAM::FDC_feat_val_abs_max

protected

Feature absolute value (float64 read/write) addr: 0-17.

◆ FDC_feat_val_abs_min

int FirewireWinDCAM::FDC_feat_val_abs_min

protected

Feature absolute maximum boundry value (float64 read) addr: 0-17.

◆ FDC_feat_val_max

int FirewireWinDCAM::FDC_feat_val_max

protected

◆ FDC_feat_val_min

int FirewireWinDCAM::FDC_feat_val_min

protected

Feature maximum boundry value (int32 read) addr: 0-17.

◆ FDC_format

int FirewireWinDCAM::FDC_format

protected

Feature has absolute (floating point) controls available 1=available 0=not available (int32 read)

◆ FDC_framerate

int FirewireWinDCAM::FDC_framerate

protected

Set and read back the video mode (int32 (enums) read/write)

◆ FDC_has_colorcode

int FirewireWinDCAM::FDC_has_colorcode

protected

Read back whether video framerate is supported (int32, read)

◆ FDC_has_format

int FirewireWinDCAM::FDC_has_format

protected

Read back the valid color codes (octet, read)

◆ FDC_has_framerate

int FirewireWinDCAM::FDC_has_framerate

protected

Read back whether video mode is supported (int32, read)

◆ FDC_has_mode

int FirewireWinDCAM::FDC_has_mode

protected

Read back whether video format is supported (int32, read)

◆ FDC_mode

int FirewireWinDCAM::FDC_mode

protected

Set and read back the video format (int32 (enums) read/write)

◆ FDC_readout_time

int FirewireWinDCAM::FDC_readout_time

protected

Read back the current color mcde (octet, read)

◆ FDC_valid_colorcode

int FirewireWinDCAM::FDC_valid_colorcode

protected

Read back the valid frame rates (octet, read)

◆ FDC_valid_format

int FirewireWinDCAM::FDC_valid_format

protected

Set and read back the color code (int32 (enums) read/write)

◆ FDC_valid_framerate

int FirewireWinDCAM::FDC_valid_framerate

protected

Read back the valid video modes (octet, read)

◆ FDC_valid_mode

int FirewireWinDCAM::FDC_valid_mode

protected

Read back the valid video formats (octet, read)

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

/home/runner/work/areaDetector/areaDetector/ADFireWireWin/firewireWinApp/src/firewireWinDCAM.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FirewireWinDCAM()

Member Function Documentation

◆ imageGrabTask()

◆ report()

◆ writeFloat64()

◆ writeInt32()

Member Data Documentation

◆ FDC_colorcode

◆ FDC_current_colorcode

◆ FDC_current_format

◆ FDC_current_framerate

◆ FDC_current_mode

◆ FDC_dropped_frames

◆ FDC_feat_absolute

◆ FDC_feat_available

◆ FDC_feat_mode

◆ FDC_feat_val

◆ FDC_feat_val_abs

◆ FDC_feat_val_abs_max

◆ FDC_feat_val_abs_min

◆ FDC_feat_val_max

◆ FDC_feat_val_min

◆ FDC_format

◆ FDC_framerate

◆ FDC_has_colorcode

◆ FDC_has_format

◆ FDC_has_framerate

◆ FDC_has_mode

◆ FDC_mode

◆ FDC_readout_time

◆ FDC_valid_colorcode

◆ FDC_valid_format

◆ FDC_valid_framerate

◆ FDC_valid_mode