marCCD Class Reference

Driver for marCCD (Rayonix) CCD detector; communicates with the marCCD program over a TCP/IP socket with the marccd_server_socket program that they distribute. More...

Inheritance diagram for marCCD:

ADDriver asynNDArrayDriver

List of all members.

Public Member Functions

 marCCD (const char *portName, const char *marCCDPort, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 Constructor for marCCD 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 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.
void report (FILE *fp, int details)
 Report status of the driver.
void marCCDTask ()
 This should be private but is called from C, must be public.
void getImageDataTask ()
 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.


Detailed Description

Driver for marCCD (Rayonix) CCD detector; communicates with the marCCD program over a TCP/IP socket with the marccd_server_socket program that they distribute.

The marCCD program must be set into Acquire/Remote Control/Start to use this driver.


Constructor & Destructor Documentation

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

Constructor for marCCD 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 marccd_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

asynStatus marCCD::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. Uses asynPortDriver::drvUserCreateParam.

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

Reimplemented from ADDriver.

void marCCD::getImageDataTask (  ) 

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

This task does the correction and file saving in the background, so that acquisition can be overlapped with these operations.

void marCCD::marCCDTask (  ) 

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 marCCD::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 marCCD::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

epicsEventId marCCD::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 25 16:53:04 2009 for areaDetector by  doxygen 1.5.7.1