areaDetector  3-14
EPICS areaDetector framework
Public Types | Public Member Functions | Protected Attributes | List of all members
eigerDetector Class Reference

#include <eigerDetector.h>

Inheritance diagram for eigerDetector:
ADDriver asynNDArrayDriver

Public Types

enum  roi_mode { ROI_MODE_DISABLED , ROI_MODE_4M }
 
enum  compression_algo { COMP_ALGO_LZ4 , COMP_ALGO_BSLZ4 }
 
enum  trigger_mode {
  TRIGGER_MODE_INTS , TRIGGER_MODE_INTE , TRIGGER_MODE_EXTS , TRIGGER_MODE_EXTE ,
  TRIGGER_MODE_CONTINUOUS , TRIGGER_MODE_EXTG
}
 

Public Member Functions

 eigerDetector (const char *portName, const char *serverHostname, int maxBuffers, size_t maxMemory, int priority, int stackSize)
 
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Sets an int32 parameter. More...
 
virtual asynStatus writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
 
virtual asynStatus writeOctet (asynUser *pasynUser, const char *value, size_t nChars, size_t *nActual)
 Called when asyn clients call pasynOctet->write(). More...
 
void report (FILE *fp, int details)
 Report status of the driver. More...
 
virtual asynStatus drvUserCreate (asynUser *pasynUser, const char *drvInfo, const char **pptypeName, size_t *psize)
 
void controlTask (void)
 
void pollTask (void)
 
void downloadTask (void)
 
void parseTask (void)
 
void saveTask (void)
 
void reapTask (void)
 
void monitorTask (void)
 
void streamTask (void)
 
void initializeTask ()
 
- Public Member Functions inherited from 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, except numParams. More...
 
virtual asynStatus connect (asynUser *pasynUser)
 Connects driver to device; This method is called when the driver's pasynCommon->connect() function is called. More...
 
virtual void setShutter (int open)
 Set the shutter position. More...
 
- Public Member Functions inherited from asynNDArrayDriver
 asynNDArrayDriver (const char *portName, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize)
 This is the constructor for the asynNDArrayDriver class. More...
 
virtual ~asynNDArrayDriver ()
 
virtual asynStatus readGenericPointer (asynUser *pasynUser, void *genericPointer)
 This method copies an NDArray object from the asynNDArrayDriver to an NDArray pointer passed in by the caller. More...
 
virtual asynStatus writeGenericPointer (asynUser *pasynUser, void *genericPointer)
 This method currently does nothing, but it should be implemented in this base class. More...
 
virtual asynStatus setIntegerParam (int index, int value)
 Sets the value for an integer in the parameter library. More...
 
virtual asynStatus setIntegerParam (int list, int index, int value)
 Sets the value for an integer in the parameter library. More...
 
virtual asynStatus createFilePath (const char *path, int pathDepth)
 Function to create a directory path for a file. More...
 
virtual asynStatus checkPath ()
 Checks whether the directory specified NDFilePath parameter exists. More...
 
virtual bool checkPath (std::string &filePath)
 Checks whether the directory specified exists. More...
 
virtual asynStatus createFileName (int maxChars, char *fullFileName)
 Build a file name from component parts. More...
 
virtual asynStatus createFileName (int maxChars, char *filePath, char *fileName)
 Build a file name from component parts. More...
 
virtual asynStatus readNDAttributesFile ()
 Create this driver's NDAttributeList (pAttributeList) by reading an XML file This clears any existing attributes from this drivers' NDAttributeList and then creates a new list based on the XML file. More...
 
virtual asynStatus getAttributes (NDAttributeList *pAttributeList)
 Get the current values of attributes from this driver and appends them to an output attribute list. More...
 
virtual void updateTimeStamps (NDArray *pArray)
 
asynStatus incrementQueuedArrayCount ()
 
asynStatus decrementQueuedArrayCount ()
 
int getQueuedArrayCount ()
 
void updateQueuedArrayCount ()
 

Protected Attributes

EigerParam * mDataSource
 
EigerParam * mFWAutoRemove
 
EigerParam * mTrigger
 
EigerParam * mTriggerExp
 
EigerParam * mManualTrigger
 
EigerParam * mTriggerStartDelay
 
EigerParam * mArmed
 
EigerParam * mSequenceId
 
EigerParam * mPendingFiles
 
EigerParam * mSaveFiles
 
EigerParam * mFileOwner
 
EigerParam * mFileOwnerGroup
 
EigerParam * mFilePerms
 
EigerParam * mMonitorTimeout
 
EigerParam * mStreamDecompress
 
EigerParam * mInitialize
 
EigerParam * mHVResetTime
 
EigerParam * mHVReset
 
EigerParam * mWavelengthEpsilon
 
EigerParam * mEnergyEpsilon
 
EigerParam * mDescription
 
EigerParam * mWavelength
 
EigerParam * mPhotonEnergy
 
EigerParam * mThreshold
 
EigerParam * mThreshold1Enable
 
EigerParam * mThreshold2
 
EigerParam * mThreshold2Enable
 
EigerParam * mThresholdDiffEnable
 
EigerParam * mNTriggers
 
EigerParam * mExtGateMode
 
EigerParam * mCompressionAlgo
 
EigerParam * mROIMode
 
EigerParam * mAutoSummation
 
EigerParam * mState
 
EigerParam * mHVState
 
EigerParam * mError
 
EigerParam * mThTemp0
 
EigerParam * mThHumid0
 
EigerParam * mLink0
 
EigerParam * mLink1
 
EigerParam * mLink2
 
EigerParam * mLink3
 
EigerParam * mDCUBufFree
 
EigerParam * mFWEnable
 
EigerParam * mFWCompression
 
EigerParam * mFWNamePattern
 
EigerParam * mFWNImgsPerFile
 
EigerParam * mFWImgNumStart
 
EigerParam * mFWState
 
EigerParam * mFWFree
 
EigerParam * mFWClear
 
EigerParam * mMonitorEnable
 
EigerParam * mMonitorBufSize
 
EigerParam * mMonitorState
 
EigerParam * mStreamEnable
 
EigerParam * mStreamDropped
 
EigerParam * mStreamState
 
EigerParam * mAcquireTime
 
EigerParam * mAcquirePeriod
 
EigerParam * mNumImages
 
EigerParam * mNumExposures
 
EigerParam * mTriggerMode
 
EigerParam * mSDKVersion
 
EigerParam * mFirmwareVersion
 
EigerParam * mSerialNumber
 
EigerParam * mTemperatureActual
 
EigerParam * mNDArraySizeX
 
EigerParam * mNDArraySizeY
 
- Protected Attributes inherited from ADDriver
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 ADShutterControl
 
int ADShutterControlEPICS
 
int ADShutterStatus
 
int ADShutterMode
 
int ADShutterOpenDelay
 
int ADShutterCloseDelay
 
int ADTemperature
 
int ADTemperatureActual
 
int ADReadStatus
 
int ADStatusMessage
 
int ADStringToServer
 
int ADStringFromServer
 
bool deviceIsReachable
 
- Protected Attributes inherited from asynNDArrayDriver
int NDPortNameSelf
 
int NDADCoreVersion
 
int NDDriverVersion
 
int ADManufacturer
 
int ADModel
 
int ADSerialNumber
 
int ADSDKVersion
 
int ADFirmwareVersion
 
int ADAcquire
 
int ADAcquireBusy
 
int ADWaitForPlugins
 
int NDArraySizeX
 
int NDArraySizeY
 
int NDArraySizeZ
 
int NDArraySize
 
int NDNDimensions
 
int NDDimensions
 
int NDDataType
 
int NDColorMode
 
int NDUniqueId
 
int NDTimeStamp
 
int NDEpicsTSSec
 
int NDEpicsTSNsec
 
int NDBayerPattern
 
int NDCodec
 
int NDCompressedSize
 
int NDArrayCounter
 
int NDFilePath
 
int NDFilePathExists
 
int NDFileName
 
int NDFileNumber
 
int NDFileTemplate
 
int NDAutoIncrement
 
int NDFullFileName
 
int NDFileFormat
 
int NDAutoSave
 
int NDWriteFile
 
int NDReadFile
 
int NDFileWriteMode
 
int NDFileWriteStatus
 
int NDFileWriteMessage
 
int NDFileNumCapture
 
int NDFileNumCaptured
 
int NDFileFreeCapture
 
int NDFileCapture
 
int NDFileDeleteDriverFile
 
int NDFileLazyOpen
 
int NDFileCreateDir
 
int NDFileTempSuffix
 
int NDAttributesFile
 
int NDAttributesStatus
 
int NDAttributesMacros
 
int NDArrayData
 
int NDArrayCallbacks
 
int NDPoolMaxBuffers
 
int NDPoolAllocBuffers
 
int NDPoolPreAllocBuffers
 
int NDPoolNumPreAllocBuffers
 
int NDPoolFreeBuffers
 
int NDPoolMaxMemory
 
int NDPoolUsedMemory
 
int NDPoolEmptyFreeList
 
int NDPoolPollStats
 
int NDNumQueuedArrays
 
class NDArray ** pArrays
 An array of NDArray pointers used to store data in the driver. More...
 
class NDAttributeList * pAttributeList
 An NDAttributeList object used to obtain the current values of a set of attributes. More...
 
int threadStackSize_
 
int threadPriority_
 

Additional Inherited Members

- Public Attributes inherited from asynNDArrayDriver
class NDArrayPool * pNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 

Member Enumeration Documentation

◆ compression_algo

enum eigerDetector::compression_algo
Enumerator
COMP_ALGO_LZ4 
COMP_ALGO_BSLZ4 

◆ roi_mode

enum eigerDetector::roi_mode
Enumerator
ROI_MODE_DISABLED 
ROI_MODE_4M 

◆ trigger_mode

enum eigerDetector::trigger_mode
Enumerator
TRIGGER_MODE_INTS 
TRIGGER_MODE_INTE 
TRIGGER_MODE_EXTS 
TRIGGER_MODE_EXTE 
TRIGGER_MODE_CONTINUOUS 
TRIGGER_MODE_EXTG 

Constructor & Destructor Documentation

◆ eigerDetector()

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

Member Function Documentation

◆ controlTask()

void eigerDetector::controlTask ( void  )

◆ downloadTask()

void eigerDetector::downloadTask ( void  )

◆ drvUserCreate()

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

◆ initializeTask()

void eigerDetector::initializeTask ( )

◆ monitorTask()

void eigerDetector::monitorTask ( void  )

◆ parseTask()

void eigerDetector::parseTask ( void  )

◆ pollTask()

void eigerDetector::pollTask ( void  )

◆ reapTask()

void eigerDetector::reapTask ( void  )

◆ report()

void eigerDetector::report ( FILE *  fp,
int  details 
)
virtual

Report status of the driver.

This method calls the report function in the asynPortDriver base class. It then calls the NDArrayPool::report() method if details >5.

Parameters
[in]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >5 then NDArrayPool::report and NDAttributeList::report are both called.

Reimplemented from asynNDArrayDriver.

◆ saveTask()

void eigerDetector::saveTask ( void  )

◆ streamTask()

void eigerDetector::streamTask ( void  )

◆ writeFloat64()

asynStatus eigerDetector::writeFloat64 ( asynUser *  pasynUser,
epicsFloat64  value 
)
virtual

◆ writeInt32()

asynStatus eigerDetector::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
)
virtual

Sets an int32 parameter.

Parameters
[in]pasynUserasynUser structure that contains the function code in pasynUser->reason.
[in]valueThe 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 ADDriver.

◆ writeOctet()

asynStatus eigerDetector::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 EigerFWNamePattern 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]valueAddress of the string to write.
[in]nCharsNumber of characters to write.
[out]nActualNumber of characters actually written.

Reimplemented from asynNDArrayDriver.

Member Data Documentation

◆ mAcquirePeriod

EigerParam* eigerDetector::mAcquirePeriod
protected

◆ mAcquireTime

EigerParam* eigerDetector::mAcquireTime
protected

◆ mArmed

EigerParam* eigerDetector::mArmed
protected

◆ mAutoSummation

EigerParam* eigerDetector::mAutoSummation
protected

◆ mCompressionAlgo

EigerParam* eigerDetector::mCompressionAlgo
protected

◆ mDataSource

EigerParam* eigerDetector::mDataSource
protected

◆ mDCUBufFree

EigerParam* eigerDetector::mDCUBufFree
protected

◆ mDescription

EigerParam* eigerDetector::mDescription
protected

◆ mEnergyEpsilon

EigerParam* eigerDetector::mEnergyEpsilon
protected

◆ mError

EigerParam* eigerDetector::mError
protected

◆ mExtGateMode

EigerParam* eigerDetector::mExtGateMode
protected

◆ mFileOwner

EigerParam* eigerDetector::mFileOwner
protected

◆ mFileOwnerGroup

EigerParam* eigerDetector::mFileOwnerGroup
protected

◆ mFilePerms

EigerParam* eigerDetector::mFilePerms
protected

◆ mFirmwareVersion

EigerParam* eigerDetector::mFirmwareVersion
protected

◆ mFWAutoRemove

EigerParam* eigerDetector::mFWAutoRemove
protected

◆ mFWClear

EigerParam* eigerDetector::mFWClear
protected

◆ mFWCompression

EigerParam* eigerDetector::mFWCompression
protected

◆ mFWEnable

EigerParam* eigerDetector::mFWEnable
protected

◆ mFWFree

EigerParam* eigerDetector::mFWFree
protected

◆ mFWImgNumStart

EigerParam* eigerDetector::mFWImgNumStart
protected

◆ mFWNamePattern

EigerParam* eigerDetector::mFWNamePattern
protected

◆ mFWNImgsPerFile

EigerParam* eigerDetector::mFWNImgsPerFile
protected

◆ mFWState

EigerParam* eigerDetector::mFWState
protected

◆ mHVReset

EigerParam* eigerDetector::mHVReset
protected

◆ mHVResetTime

EigerParam* eigerDetector::mHVResetTime
protected

◆ mHVState

EigerParam* eigerDetector::mHVState
protected

◆ mInitialize

EigerParam* eigerDetector::mInitialize
protected

◆ mLink0

EigerParam* eigerDetector::mLink0
protected

◆ mLink1

EigerParam* eigerDetector::mLink1
protected

◆ mLink2

EigerParam* eigerDetector::mLink2
protected

◆ mLink3

EigerParam* eigerDetector::mLink3
protected

◆ mManualTrigger

EigerParam* eigerDetector::mManualTrigger
protected

◆ mMonitorBufSize

EigerParam* eigerDetector::mMonitorBufSize
protected

◆ mMonitorEnable

EigerParam* eigerDetector::mMonitorEnable
protected

◆ mMonitorState

EigerParam* eigerDetector::mMonitorState
protected

◆ mMonitorTimeout

EigerParam* eigerDetector::mMonitorTimeout
protected

◆ mNDArraySizeX

EigerParam* eigerDetector::mNDArraySizeX
protected

◆ mNDArraySizeY

EigerParam* eigerDetector::mNDArraySizeY
protected

◆ mNTriggers

EigerParam* eigerDetector::mNTriggers
protected

◆ mNumExposures

EigerParam* eigerDetector::mNumExposures
protected

◆ mNumImages

EigerParam* eigerDetector::mNumImages
protected

◆ mPendingFiles

EigerParam* eigerDetector::mPendingFiles
protected

◆ mPhotonEnergy

EigerParam* eigerDetector::mPhotonEnergy
protected

◆ mROIMode

EigerParam* eigerDetector::mROIMode
protected

◆ mSaveFiles

EigerParam* eigerDetector::mSaveFiles
protected

◆ mSDKVersion

EigerParam* eigerDetector::mSDKVersion
protected

◆ mSequenceId

EigerParam* eigerDetector::mSequenceId
protected

◆ mSerialNumber

EigerParam* eigerDetector::mSerialNumber
protected

◆ mState

EigerParam* eigerDetector::mState
protected

◆ mStreamDecompress

EigerParam* eigerDetector::mStreamDecompress
protected

◆ mStreamDropped

EigerParam* eigerDetector::mStreamDropped
protected

◆ mStreamEnable

EigerParam* eigerDetector::mStreamEnable
protected

◆ mStreamState

EigerParam* eigerDetector::mStreamState
protected

◆ mTemperatureActual

EigerParam* eigerDetector::mTemperatureActual
protected

◆ mThHumid0

EigerParam* eigerDetector::mThHumid0
protected

◆ mThreshold

EigerParam* eigerDetector::mThreshold
protected

◆ mThreshold1Enable

EigerParam* eigerDetector::mThreshold1Enable
protected

◆ mThreshold2

EigerParam* eigerDetector::mThreshold2
protected

◆ mThreshold2Enable

EigerParam* eigerDetector::mThreshold2Enable
protected

◆ mThresholdDiffEnable

EigerParam* eigerDetector::mThresholdDiffEnable
protected

◆ mThTemp0

EigerParam* eigerDetector::mThTemp0
protected

◆ mTrigger

EigerParam* eigerDetector::mTrigger
protected

◆ mTriggerExp

EigerParam* eigerDetector::mTriggerExp
protected

◆ mTriggerMode

EigerParam* eigerDetector::mTriggerMode
protected

◆ mTriggerStartDelay

EigerParam* eigerDetector::mTriggerStartDelay
protected

◆ mWavelength

EigerParam* eigerDetector::mWavelength
protected

◆ mWavelengthEpsilon

EigerParam* eigerDetector::mWavelengthEpsilon
protected
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1