areaDetector 1-8
Public Member Functions | Protected Attributes
roper Class Reference

Driver for Roper (Princeton Instrument and Photometrics) cameras using the COM interface to WinView or WinSpec. More...

Inheritance diagram for roper:
ADDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 roper (const char *portName, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for Roper driver; most parameters are simply passed to ADDriver::ADDriver.
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Called when asyn clients call pasynInt32->write().
virtual asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 Called when asyn clients call pasynFloat64->write().
virtual void setShutter (int open)
 Set the shutter position.
virtual asynStatus drvUserCreate (asynUser *pasynUser, const char *drvInfo, const char **pptypeName, size_t *psize)
 Sets pasynUser->reason to one of the enum values for the parameters defined for this class if the drvInfo field matches one the strings defined for it.
virtual void report (FILE *fp, int details)
 Report status of the driver.
void roperTask ()
 This thread computes new image data and does the callbacks to send it to higher layers.

Protected Attributes

int RoperShutterMode
int RoperNumAcquisitions
int RoperNumAcquisitionsCounter
int RoperAutoDataType
int RoperComment1
int RoperComment2
int RoperComment3
int RoperComment4
int RoperComment5

Detailed Description

Driver for Roper (Princeton Instrument and Photometrics) cameras using the COM interface to WinView or WinSpec.

Version 2.5.22 or later of those programs is required.


Constructor & Destructor Documentation

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

Constructor for Roper 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]portNameThe name of the asyn port driver to be created.
[in]maxBuffersThe 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]maxMemoryThe 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]priorityThe thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]stackSizeThe stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

asynStatus roper::drvUserCreate ( asynUser *  pasynUser,
const char *  drvInfo,
const char **  pptypeName,
size_t *  psize 
) [virtual]

Sets pasynUser->reason to one of the enum values for the parameters defined for this class if the drvInfo field matches one the strings defined for it.

If the parameter is not recognized by this class then calls ADDriver::drvUserCreate.

Parameters:
[in]pasynUserpasynUser structure that driver modifies
[in]drvInfoString containing information about what driver function is being referenced
[out]pptypeNameLocation in which driver puts a copy of drvInfo.
[out]psizeLocation where driver puts size of param
Returns:
Returns asynSuccess if a matching string was found, asynError if not found.

Reimplemented from asynPortDriver.

void roper::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]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >0 then driver details are printed.

Reimplemented from asynNDArrayDriver.

void roper::roperTask ( )

This thread computes new image data and does the callbacks to send it to higher layers.

void roper::setShutter ( int  open) [virtual]

Set the shutter position.

This method will open (1) or close (0) the shutter if ADShutterMode==ADShutterModeEPICS. Drivers will implement setShutter if they support ADShutterModeDetector. If ADShutterMode=ADShutterModeDetector they will control the shutter directly, else they will call this method.

Parameters:
[in]open1 (open) or 0 (closed)

Reimplemented from ADDriver.

asynStatus roper::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]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from asynPortDriver.

asynStatus roper::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]pasynUserpasynUser structure that encodes the reason and address.
[in]valueValue to write.

Reimplemented from ADDriver.


Member Data Documentation

int roper::RoperAutoDataType [protected]
int roper::RoperComment1 [protected]
int roper::RoperComment2 [protected]
int roper::RoperComment3 [protected]
int roper::RoperComment4 [protected]
int roper::RoperComment5 [protected]
int roper::RoperNumAcquisitions [protected]
int roper::RoperShutterMode [protected]

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