ADDriver Class Reference

Class from which areaDetector drivers are directly derived. More...

#include <ADDriver.h>

Inheritance diagram for ADDriver:

asynNDArrayDriver adsc FirewireWinDCAM mar345 marCCD PerkinElmer pilatusDetector prosilica pvCam roper simDetector

List of all members.

Public Member Functions

 ADDriver (const char *portName, int maxAddr, int paramTableSize, 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.
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 in ADDriver.h if the drvInfo field matches one the strings defined.
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Sets an int32 parameter.
void setShutter (int open)
 Set the shutter position.


Detailed Description

Class from which areaDetector drivers are directly derived.


Constructor & Destructor Documentation

ADDriver::ADDriver ( const char *  portName,
int  maxAddr,
int  paramTableSize,
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.

After calling the base class constructor this method sets reasonable default values for all of the parameters defined in ADDriver.h.


Member Function Documentation

asynStatus ADDriver::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 in ADDriver.h if the drvInfo field matches one the strings defined.

Simply calls asynPortDriver::drvUserCreateParam with the parameter table for this driver.

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 asynNDArrayDriver.

Reimplemented in adsc, FirewireWinDCAM, mar345, marCCD, PerkinElmer, pilatusDetector, prosilica, pvCam, roper, and simDetector.

void ADDriver::setShutter ( int  open  ) 

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] open 1 (open) or 0 (closed)

Reimplemented in roper, and simDetector.

asynStatus ADDriver::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. 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 in adsc, FirewireWinDCAM, mar345, marCCD, PerkinElmer, pilatusDetector, prosilica, pvCam, roper, and simDetector.


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

Generated on Tue Aug 25 16:53:03 2009 for areaDetector by  doxygen 1.5.7.1