/home/epics/devel/areaDetector/1-5/ADApp/ADSrc/asynNDArrayDriver.h File Reference

#include "asynPortDriver.h"
#include "NDArray.h"
#include "PVAttribute.h"

Go to the source code of this file.

Classes

class  asynNDArrayDriver
 This is the class from which NDArray drivers are derived; implements the asynGenericPointer functions for NDArray objects. More...

Defines

#define MAX_FILENAME_LEN   256
 Maximum length of a filename or any of its components.
#define NUM_ND_STANDARD_PARAMS   (sizeof(NDStdDriverParamString)/sizeof(NDStdDriverParamString[0]))

Enumerations

enum  NDFileMode_t { NDFileModeSingle, NDFileModeCapture, NDFileModeStream }
 Enumeration of file saving modes. More...
enum  NDStdDriverParam_t {
  NDPortNameSelf, NDArraySizeX, NDArraySizeY, NDArraySizeZ,
  NDArraySize, NDDataType, NDColorMode, NDArrayCounter,
  NDFilePath, NDFileName, NDFileNumber, NDFileTemplate,
  NDAutoIncrement, NDFullFileName, NDFileFormat, NDAutoSave,
  NDWriteFile, NDReadFile, NDFileWriteMode, NDFileNumCapture,
  NDFileNumCaptured, NDFileCapture, NDAttributesFile, NDArrayData,
  NDArrayCallbacks, NDLastStdParam
}
 Enumeration of parameters that affect the behaviour of the detector. More...


Define Documentation

#define MAX_FILENAME_LEN   256

Maximum length of a filename or any of its components.

#define NUM_ND_STANDARD_PARAMS   (sizeof(NDStdDriverParamString)/sizeof(NDStdDriverParamString[0]))


Enumeration Type Documentation

Enumeration of file saving modes.

Enumerator:
NDFileModeSingle  Write 1 array per file.
NDFileModeCapture  Capture NDNumCapture arrays into memory, write them out when capture is complete.

Write all captured arrays to a single file if the file format supports this

NDFileModeStream  Stream arrays continuously to a single file if the file format supports this.

Enumeration of parameters that affect the behaviour of the detector.

These are the values that asyn will place in pasynUser->reason when the standard asyn interface methods are called.

Enumerator:
NDPortNameSelf  (asynOctet, r/o) Asyn port name of this driver instance
NDArraySizeX  (asynInt32, r/o) Size of the array data in the X direction
NDArraySizeY  (asynInt32, r/o) Size of the array data in the Y direction
NDArraySizeZ  (asynInt32, r/o) Size of the array data in the Z direction
NDArraySize  (asynInt32, r/o) Total size of array data in bytes
NDDataType  (asynInt32, r/w) Data type (NDDataType_t)
NDColorMode  (asynInt32, r/w) Color mode (NDColorMode_t)
NDArrayCounter  (asynInt32, r/w) Number of arrays since last reset
NDFilePath  (asynOctet, r/w) The file path
NDFileName  (asynOctet, r/w) The file name
NDFileNumber  (asynInt32, r/w) The next file number
NDFileTemplate  (asynOctet, r/w) The file format template; C-style format string
NDAutoIncrement  (asynInt32, r/w) Autoincrement file number; 0=No, 1=Yes
NDFullFileName  (asynOctet, r/o) The actual complete file name for the last file saved
NDFileFormat  (asynInt32, r/w) The data format to use for saving the file.

NDAutoSave  (asynInt32, r/w) Automatically save files
NDWriteFile  (asynInt32, r/w) Manually save the most recent array to a file when value=1
NDReadFile  (asynInt32, r/w) Manually read file when value=1
NDFileWriteMode  (asynInt32, r/w) File saving mode (NDFileMode_t)
NDFileNumCapture  (asynInt32, r/w) Number of arrays to capture
NDFileNumCaptured  (asynInt32, r/o) Number of arrays already captured
NDFileCapture  (asynInt32, r/w) Start or stop capturing arrays
NDAttributesFile  (asynOctet, r/w) Attributes file name
NDArrayData  (asynGenericPointer, r/w) NDArray data
NDArrayCallbacks  (asynInt32, r/w) Do callbacks with array data (0=No, 1=Yes)
NDLastStdParam  The last standard ND driver parameter; Derived classes must begin their specific parameter enums with this value.


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