areaDetector  3-12-1
EPICS areaDetector framework
Public Member Functions | Public Attributes | Protected Attributes | List of all members
pvCam Class Reference

Driver for Roper (Photometrics and Princeton Instruments) cameras using the PvCam library. More...

#include <pvCamSrc.h>

Inheritance diagram for pvCam:
ADDriver asynNDArrayDriver

Public Member Functions

 pvCam (const char *portName, int maxSizeX, int maxSizeY, NDDataType_t dataType, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Sets an int32 parameter. More...
 
virtual asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 
void report (FILE *fp, int details)
 Report status of the driver. More...
 
template<typename epicsType >
int computeArray (int maxSizeX, int maxSizeY)
 
int allocateBuffer ()
 
int computeImage ()
 
void pvCamAcquisitionTask ()
 
void pvCamMonitorTask ()
 
 ~pvCam ()
 
- 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

int imagesRemaining
 
epicsEventId startEventId
 
epicsEventId stopEventId
 
NDArray * pRaw
 
- Public Attributes inherited from asynNDArrayDriver
class NDArrayPool * pNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 

Protected Attributes

int PVCamInitDetector
 
int PVCamSlot1Cam
 
int PVCamSlot2Cam
 
int PVCamSlot3Cam
 
int PVCamDetectorSelected
 
int PVCamChipNameRBV
 
int PVCamNumParallelPixelsRBV
 
int PVCamNumSerialPixelsRBV
 
int PVCamPixelParallelSizeRBV
 
int PVCamPixelSerialSizeRBV
 
int PVCamChipHeightMMRBV
 
int PVCamChipWidthMMRBV
 
int PVCamPixelParallelDistRBV
 
int PVCamPixelSerialDistRBV
 
int PVCamPostMaskRBV
 
int PVCamPreMaskRBV
 
int PVCamPostScanRBV
 
int PVCamPreScanRBV
 
int PVCamNumPortsRBV
 
int PVCamFullWellCapacityRBV
 
int PVCamFrameTransferCapableRBV
 
int PVCamNumSpeedTableEntriesRBV
 
int PVCamSpeedTableIndex
 
int PVCamSpeedTableIndexRBV
 
int PVCamBitDepthRBV
 
int PVCamPixelTimeRBV
 
int PVCamGainIndex
 
int PVCamGainIndexRBV
 
int PVCamMaxGainIndexRBV
 
int PVCamMinShutterOpenDelayRBV
 
int PVCamMaxShutterOpenDelayRBV
 
int PVCamMinShutterCloseDelayRBV
 
int PVCamMaxShutterCloseDelayRBV
 
int PVCamShutterOpenDelay
 
int PVCamShutterOpenDelayRBV
 
int PVCamShutterCloseDelay
 
int PVCamShutterCloseDelayRBV
 
int PVCamMeasuredTemperatureRBV
 
int PVCamMinTemperatureRBV
 
int PVCamMaxTemperatureRBV
 
int PVCamSetTemperature
 
int PVCamSetTemperatureRBV
 
int PVCamDetectorMode
 
int PVCamDetectorModeRBV
 
int PVCamTriggerMode
 
int PVCamTriggerModeRBV
 
int PVCamTriggerEdge
 
int PVCamTriggerEdgeRBV
 
int PVCamCamFirmwareVersRBV
 
int PVCamPCIFWVersRBV
 
int PVCamHeadSerialNumRBV
 
int PVCamSerialNumRBV
 
int PVCamPVCamVersRBV
 
int PVCamDevDrvVersRBV
 
- 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

Driver for Roper (Photometrics and Princeton Instruments) cameras using the PvCam library.

Constructor & Destructor Documentation

◆ pvCam()

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

◆ ~pvCam()

pvCam::~pvCam ( )

Member Function Documentation

◆ allocateBuffer()

int pvCam::allocateBuffer ( )

◆ computeArray()

template<typename epicsType >
int pvCam::computeArray ( int  maxSizeX,
int  maxSizeY 
)

◆ computeImage()

int pvCam::computeImage ( )

◆ pvCamAcquisitionTask()

void pvCam::pvCamAcquisitionTask ( )

◆ pvCamMonitorTask()

void pvCam::pvCamMonitorTask ( )

◆ report()

void pvCam::report ( FILE *  fp,
int  details 
)
virtual

Report status of the driver.

This method calls the report function in the asynPortDriver base class. It then calls the NDArrayPool::report() method if details >5.

Parameters
[in]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >5 then NDArrayPool::report and NDAttributeList::report are both called.

Reimplemented from asynNDArrayDriver.

◆ writeFloat64()

asynStatus pvCam::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
)
virtual

◆ writeInt32()

asynStatus pvCam::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
)
virtual

Sets an int32 parameter.

Parameters
[in]pasynUserasynUser structure that contains the function code in pasynUser->reason.
[in]valueThe value for this parameter

Takes action if the function code requires it. Currently only ADShutterControl requires action here. This method is normally called from the writeInt32 method in derived classes, which should set the value of the parameter in the parameter library.

Reimplemented from ADDriver.

Member Data Documentation

◆ imagesRemaining

int pvCam::imagesRemaining

◆ pRaw

NDArray* pvCam::pRaw

◆ PVCamBitDepthRBV

int pvCam::PVCamBitDepthRBV
protected

◆ PVCamCamFirmwareVersRBV

int pvCam::PVCamCamFirmwareVersRBV
protected

◆ PVCamChipHeightMMRBV

int pvCam::PVCamChipHeightMMRBV
protected

◆ PVCamChipNameRBV

int pvCam::PVCamChipNameRBV
protected

◆ PVCamChipWidthMMRBV

int pvCam::PVCamChipWidthMMRBV
protected

◆ PVCamDetectorMode

int pvCam::PVCamDetectorMode
protected

◆ PVCamDetectorModeRBV

int pvCam::PVCamDetectorModeRBV
protected

◆ PVCamDetectorSelected

int pvCam::PVCamDetectorSelected
protected

◆ PVCamDevDrvVersRBV

int pvCam::PVCamDevDrvVersRBV
protected

◆ PVCamFrameTransferCapableRBV

int pvCam::PVCamFrameTransferCapableRBV
protected

◆ PVCamFullWellCapacityRBV

int pvCam::PVCamFullWellCapacityRBV
protected

◆ PVCamGainIndex

int pvCam::PVCamGainIndex
protected

◆ PVCamGainIndexRBV

int pvCam::PVCamGainIndexRBV
protected

◆ PVCamHeadSerialNumRBV

int pvCam::PVCamHeadSerialNumRBV
protected

◆ PVCamInitDetector

int pvCam::PVCamInitDetector
protected

◆ PVCamMaxGainIndexRBV

int pvCam::PVCamMaxGainIndexRBV
protected

◆ PVCamMaxShutterCloseDelayRBV

int pvCam::PVCamMaxShutterCloseDelayRBV
protected

◆ PVCamMaxShutterOpenDelayRBV

int pvCam::PVCamMaxShutterOpenDelayRBV
protected

◆ PVCamMaxTemperatureRBV

int pvCam::PVCamMaxTemperatureRBV
protected

◆ PVCamMeasuredTemperatureRBV

int pvCam::PVCamMeasuredTemperatureRBV
protected

◆ PVCamMinShutterCloseDelayRBV

int pvCam::PVCamMinShutterCloseDelayRBV
protected

◆ PVCamMinShutterOpenDelayRBV

int pvCam::PVCamMinShutterOpenDelayRBV
protected

◆ PVCamMinTemperatureRBV

int pvCam::PVCamMinTemperatureRBV
protected

◆ PVCamNumParallelPixelsRBV

int pvCam::PVCamNumParallelPixelsRBV
protected

◆ PVCamNumPortsRBV

int pvCam::PVCamNumPortsRBV
protected

◆ PVCamNumSerialPixelsRBV

int pvCam::PVCamNumSerialPixelsRBV
protected

◆ PVCamNumSpeedTableEntriesRBV

int pvCam::PVCamNumSpeedTableEntriesRBV
protected

◆ PVCamPCIFWVersRBV

int pvCam::PVCamPCIFWVersRBV
protected

◆ PVCamPixelParallelDistRBV

int pvCam::PVCamPixelParallelDistRBV
protected

◆ PVCamPixelParallelSizeRBV

int pvCam::PVCamPixelParallelSizeRBV
protected

◆ PVCamPixelSerialDistRBV

int pvCam::PVCamPixelSerialDistRBV
protected

◆ PVCamPixelSerialSizeRBV

int pvCam::PVCamPixelSerialSizeRBV
protected

◆ PVCamPixelTimeRBV

int pvCam::PVCamPixelTimeRBV
protected

◆ PVCamPostMaskRBV

int pvCam::PVCamPostMaskRBV
protected

◆ PVCamPostScanRBV

int pvCam::PVCamPostScanRBV
protected

◆ PVCamPreMaskRBV

int pvCam::PVCamPreMaskRBV
protected

◆ PVCamPreScanRBV

int pvCam::PVCamPreScanRBV
protected

◆ PVCamPVCamVersRBV

int pvCam::PVCamPVCamVersRBV
protected

◆ PVCamSerialNumRBV

int pvCam::PVCamSerialNumRBV
protected

◆ PVCamSetTemperature

int pvCam::PVCamSetTemperature
protected

◆ PVCamSetTemperatureRBV

int pvCam::PVCamSetTemperatureRBV
protected

◆ PVCamShutterCloseDelay

int pvCam::PVCamShutterCloseDelay
protected

◆ PVCamShutterCloseDelayRBV

int pvCam::PVCamShutterCloseDelayRBV
protected

◆ PVCamShutterOpenDelay

int pvCam::PVCamShutterOpenDelay
protected

◆ PVCamShutterOpenDelayRBV

int pvCam::PVCamShutterOpenDelayRBV
protected

◆ PVCamSlot1Cam

int pvCam::PVCamSlot1Cam
protected

◆ PVCamSlot2Cam

int pvCam::PVCamSlot2Cam
protected

◆ PVCamSlot3Cam

int pvCam::PVCamSlot3Cam
protected

◆ PVCamSpeedTableIndex

int pvCam::PVCamSpeedTableIndex
protected

◆ PVCamSpeedTableIndexRBV

int pvCam::PVCamSpeedTableIndexRBV
protected

◆ PVCamTriggerEdge

int pvCam::PVCamTriggerEdge
protected

◆ PVCamTriggerEdgeRBV

int pvCam::PVCamTriggerEdgeRBV
protected

◆ PVCamTriggerMode

int pvCam::PVCamTriggerMode
protected

◆ PVCamTriggerModeRBV

int pvCam::PVCamTriggerModeRBV
protected

◆ startEventId

epicsEventId pvCam::startEventId

◆ stopEventId

epicsEventId pvCam::stopEventId
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15