ADDriver Class Reference

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

#include <ADDriver.h>

Inheritance diagram for ADDriver:

asynNDArrayDriver asynPortDriver adsc FirewireWinDCAM mar345 marCCD PerkinElmer pilatusDetector prosilica pvCam roper simDetector

List of all members.

Public Member Functions

 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.
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Sets an int32 parameter.
void setShutter (int open)
 Set the shutter position.

Protected Attributes

int ADManufacturer
int ADModel
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 ADAcquire
int ADShutterControl
int ADShutterControlEPICS
int ADShutterStatus
int ADShutterMode
int ADShutterOpenDelay
int ADShutterCloseDelay
int ADTemperature
int ADReadStatus
int ADStatusMessage
int ADStringToServer
int ADStringFromServer


Detailed Description

Class from which areaDetector drivers are directly derived.


Constructor & Destructor Documentation

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.

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


Member Function Documentation

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 from asynPortDriver.

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


Member Data Documentation

int ADDriver::ADAcquire [protected]

int ADDriver::ADAcquirePeriod [protected]

int ADDriver::ADAcquireTime [protected]

int ADDriver::ADBinX [protected]

int ADDriver::ADBinY [protected]

int ADDriver::ADFrameType [protected]

int ADDriver::ADGain [protected]

int ADDriver::ADImageMode [protected]

int ADDriver::ADManufacturer [protected]

int ADDriver::ADMaxSizeX [protected]

int ADDriver::ADMaxSizeY [protected]

int ADDriver::ADMinX [protected]

int ADDriver::ADMinY [protected]

int ADDriver::ADModel [protected]

int ADDriver::ADNumExposures [protected]

int ADDriver::ADNumImages [protected]

int ADDriver::ADReadStatus [protected]

int ADDriver::ADReverseX [protected]

int ADDriver::ADReverseY [protected]

int ADDriver::ADShutterControl [protected]

int ADDriver::ADShutterMode [protected]

int ADDriver::ADShutterStatus [protected]

int ADDriver::ADSizeX [protected]

int ADDriver::ADSizeY [protected]

int ADDriver::ADStatus [protected]

int ADDriver::ADStatusMessage [protected]

int ADDriver::ADStringToServer [protected]

int ADDriver::ADTemperature [protected]

int ADDriver::ADTimeRemaining [protected]

int ADDriver::ADTriggerMode [protected]


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

Generated on Thu May 20 18:01:43 2010 for areaDetector by  doxygen 1.5.7.1