PSL Class Reference

Driver for Photonic Sciencies Ltd. More...

Inheritance diagram for PSL:

ADDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 PSL (const char *portName, const char *PSLPort, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for PSL 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 asynStatus writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual)
 Called when asyn clients call pasynOctet->write().
void report (FILE *fp, int details)
 Report status of the driver.
void PSLTask ()
 This should be private but is called from C, must be public.

Public Attributes

epicsEventId stopEventId
 This should be private but is accessed from C, must be public.

Protected Attributes

int PSLOffOn
int PSLReset


Detailed Description

Driver for Photonic Sciencies Ltd.

CCD detector; communicates with the PSL servr over a TCP/IP socket. The server must be started with the PSL Software Menu/Connexion.


Constructor & Destructor Documentation

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

Constructor for PSL 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 the parameters defined in this class, asynNDArrayDriver, and ADDriver.

Parameters:
[in] portName The name of the asyn port driver to be created.
[in] serverPort The name of the asyn port driver previously created with drvAsynIPPortConfigure connected to the PSL_server program.
[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

void PSL::PSLTask (  ) 

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

This thread controls acquisition, reads TIFF files to get the image data, and does the callbacks to send it to higher layers.

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

asynStatus PSL::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
) [virtual]

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

This function performs actions for some parameters. 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 asynPortDriver.

asynStatus PSL::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.

asynStatus PSL::writeOctet ( asynUser *  pasynUser,
const char *  value,
size_t  nChars,
size_t *  nActual 
) [virtual]

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

This function performs actions for some parameters, including PilatusBadPixelFile, ADFilePath, 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 Address of the string to write.
[in] nChars Number of characters to write.
[out] nActual Number of characters actually written.

Reimplemented from asynNDArrayDriver.


Member Data Documentation

int PSL::PSLOffOn [protected]

int PSL::PSLReset [protected]

epicsEventId PSL::stopEventId

This should be private but is accessed from C, must be public.


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

Generated on Tue Aug 9 14:44:39 2011 for areaDetector by  doxygen 1.5.7.1