/home/epics/devel/areaDetector/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 NDPortNameSelfString   "PORT_NAME_SELF"
 Strings defining parameters that affect the behaviour of the detector.
#define NDArraySizeXString   "ARRAY_SIZE_X"
 (asynInt32, r/o) Size of the array data in the X direction
#define NDArraySizeYString   "ARRAY_SIZE_Y"
 (asynInt32, r/o) Size of the array data in the Y direction
#define NDArraySizeZString   "ARRAY_SIZE_Z"
 (asynInt32, r/o) Size of the array data in the Z direction
#define NDArraySizeString   "ARRAY_SIZE"
 (asynInt32, r/o) Total size of array data in bytes
#define NDNDimensionsString   "ARRAY_NDIMENSIONS"
 (asynInt32, r/o) Number of dimensions in array
#define NDDimensionsString   "ARRAY_DIMENSIONS"
 (asynInt32Array, r/o) Array dimensions
#define NDDataTypeString   "DATA_TYPE"
 (asynInt32, r/w) Data type (NDDataType_t)
#define NDColorModeString   "COLOR_MODE"
 (asynInt32, r/w) Color mode (NDColorMode_t)
#define NDUniqueIdString   "UNIQUE_ID"
 (asynInt32, r/o) Unique ID number of array
#define NDTimeStampString   "TIME_STAMP"
 (asynFloat64, r/o) Time stamp of array
#define NDBayerPatternString   "BAYER_PATTERN"
 (asynInt32, r/o) Bayer pattern of array (from bayerPattern array attribute if present)
#define NDArrayCounterString   "ARRAY_COUNTER"
 (asynInt32, r/w) Number of arrays since last reset
#define NDFilePathString   "FILE_PATH"
 (asynOctet, r/w) The file path
#define NDFilePathExistsString   "FILE_PATH_EXISTS"
 (asynInt32, r/w) File path exists?
#define NDFileNameString   "FILE_NAME"
 (asynOctet, r/w) The file name
#define NDFileNumberString   "FILE_NUMBER"
 (asynInt32, r/w) The next file number
#define NDFileTemplateString   "FILE_TEMPLATE"
 (asynOctet, r/w) The file format template; C-style format string
#define NDAutoIncrementString   "AUTO_INCREMENT"
 (asynInt32, r/w) Autoincrement file number; 0=No, 1=Yes
#define NDFullFileNameString   "FULL_FILE_NAME"
 (asynOctet, r/o) The actual complete file name for the last file saved
#define NDFileFormatString   "FILE_FORMAT"
 (asynInt32, r/w) The data format to use for saving the file.
#define NDAutoSaveString   "AUTO_SAVE"
 (asynInt32, r/w) Automatically save files
#define NDWriteFileString   "WRITE_FILE"
 (asynInt32, r/w) Manually save the most recent array to a file when value=1
#define NDReadFileString   "READ_FILE"
 (asynInt32, r/w) Manually read file when value=1
#define NDFileWriteModeString   "WRITE_MODE"
 (asynInt32, r/w) File saving mode (NDFileMode_t)
#define NDFileNumCaptureString   "NUM_CAPTURE"
 (asynInt32, r/w) Number of arrays to capture
#define NDFileNumCapturedString   "NUM_CAPTURED"
 (asynInt32, r/o) Number of arrays already captured
#define NDFileCaptureString   "CAPTURE"
 (asynInt32, r/w) Start or stop capturing arrays
#define NDAttributesFileString   "ND_ATTRIBUTES_FILE"
 (asynOctet, r/w) Attributes file name
#define NDArrayDataString   "ARRAY_DATA"
 (asynGenericPointer, r/w) NDArray data
#define NDArrayCallbacksString   "ARRAY_CALLBACKS"
 (asynInt32, r/w) Do callbacks with array data (0=No, 1=Yes)
#define FIRST_NDARRAY_PARAM   NDPortNameSelf
#define LAST_NDARRAY_PARAM   NDArrayCallbacks
#define NUM_NDARRAY_PARAMS   (&LAST_NDARRAY_PARAM - &FIRST_NDARRAY_PARAM + 1)

Enumerations

enum  NDFileMode_t { NDFileModeSingle, NDFileModeCapture, NDFileModeStream }
 Enumeration of file saving modes. More...


Define Documentation

#define FIRST_NDARRAY_PARAM   NDPortNameSelf

#define LAST_NDARRAY_PARAM   NDArrayCallbacks

#define MAX_FILENAME_LEN   256

Maximum length of a filename or any of its components.

#define NDArrayCallbacksString   "ARRAY_CALLBACKS"

(asynInt32, r/w) Do callbacks with array data (0=No, 1=Yes)

#define NDArrayCounterString   "ARRAY_COUNTER"

(asynInt32, r/w) Number of arrays since last reset

#define NDArrayDataString   "ARRAY_DATA"

(asynGenericPointer, r/w) NDArray data

#define NDArraySizeString   "ARRAY_SIZE"

(asynInt32, r/o) Total size of array data in bytes

#define NDArraySizeXString   "ARRAY_SIZE_X"

(asynInt32, r/o) Size of the array data in the X direction

#define NDArraySizeYString   "ARRAY_SIZE_Y"

(asynInt32, r/o) Size of the array data in the Y direction

#define NDArraySizeZString   "ARRAY_SIZE_Z"

(asynInt32, r/o) Size of the array data in the Z direction

#define NDAttributesFileString   "ND_ATTRIBUTES_FILE"

(asynOctet, r/w) Attributes file name

#define NDAutoIncrementString   "AUTO_INCREMENT"

(asynInt32, r/w) Autoincrement file number; 0=No, 1=Yes

#define NDAutoSaveString   "AUTO_SAVE"

(asynInt32, r/w) Automatically save files

#define NDBayerPatternString   "BAYER_PATTERN"

(asynInt32, r/o) Bayer pattern of array (from bayerPattern array attribute if present)

#define NDColorModeString   "COLOR_MODE"

(asynInt32, r/w) Color mode (NDColorMode_t)

#define NDDataTypeString   "DATA_TYPE"

(asynInt32, r/w) Data type (NDDataType_t)

#define NDDimensionsString   "ARRAY_DIMENSIONS"

(asynInt32Array, r/o) Array dimensions

#define NDFileCaptureString   "CAPTURE"

(asynInt32, r/w) Start or stop capturing arrays

#define NDFileFormatString   "FILE_FORMAT"

(asynInt32, r/w) The data format to use for saving the file.

#define NDFileNameString   "FILE_NAME"

(asynOctet, r/w) The file name

#define NDFileNumberString   "FILE_NUMBER"

(asynInt32, r/w) The next file number

#define NDFileNumCapturedString   "NUM_CAPTURED"

(asynInt32, r/o) Number of arrays already captured

#define NDFileNumCaptureString   "NUM_CAPTURE"

(asynInt32, r/w) Number of arrays to capture

#define NDFilePathExistsString   "FILE_PATH_EXISTS"

(asynInt32, r/w) File path exists?

#define NDFilePathString   "FILE_PATH"

(asynOctet, r/w) The file path

#define NDFileTemplateString   "FILE_TEMPLATE"

(asynOctet, r/w) The file format template; C-style format string

#define NDFileWriteModeString   "WRITE_MODE"

(asynInt32, r/w) File saving mode (NDFileMode_t)

#define NDFullFileNameString   "FULL_FILE_NAME"

(asynOctet, r/o) The actual complete file name for the last file saved

#define NDNDimensionsString   "ARRAY_NDIMENSIONS"

(asynInt32, r/o) Number of dimensions in array

#define NDPortNameSelfString   "PORT_NAME_SELF"

Strings defining parameters that affect the behaviour of the detector.

These are the values passed to drvUserCreate. The driver will place in pasynUser->reason an integer to be used when the standard asyn interface methods are called. (asynOctet, r/o) Asyn port name of this driver instance

#define NDReadFileString   "READ_FILE"

(asynInt32, r/w) Manually read file when value=1

#define NDTimeStampString   "TIME_STAMP"

(asynFloat64, r/o) Time stamp of array

#define NDUniqueIdString   "UNIQUE_ID"

(asynInt32, r/o) Unique ID number of array

#define NDWriteFileString   "WRITE_FILE"

(asynInt32, r/w) Manually save the most recent array to a file when value=1

#define NUM_NDARRAY_PARAMS   (&LAST_NDARRAY_PARAM - &FIRST_NDARRAY_PARAM + 1)


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.


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