asynNDArrayDriver.h

Go to the documentation of this file.

#ifndef asynNDArrayDriver_H
#define asynNDArrayDriver_H

#include <epicsMutex.h>
#include <epicsEvent.h>

#include "asynPortDriver.h"
#include "NDArray.h"
#include "ADCoreVersion.h"

#define MAX_FILENAME_LEN 256

typedef enum {
    NDFileModeSingle,       
    NDFileModeCapture,      
    NDFileModeStream        
} NDFileMode_t;

typedef enum {
    NDFileWriteOK,
    NDFileWriteError
} NDFileWriteStatus_t;

typedef enum {
    NDAttributesOK,
    NDAttributesFileNotFound,
    NDAttributesXMLSyntaxError,
    NDAttributesMacroError
} NDAttributesStatus_t;

 /*                               String                 asyn interface  access   Description  */
#define NDPortNameSelfString    "PORT_NAME_SELF"    
#define NDADCoreVersionString   "ADCORE_VERSION"    
#define NDDriverVersionString   "DRIVER_VERSION"    
/* These parameters were previously in ADDriver.h.
 * We moved them here so they can be used by other types of drivers
 * For consistency the #define and parameter names should begin with ND rather than AD but that would break
 * backwards compatibility. */
#define ADManufacturerString        "MANUFACTURER"          
#define ADModelString               "MODEL"                 
#define ADSerialNumberString        "SERIAL_NUMBER"         
#define ADSDKVersionString          "SDK_VERSION"           
#define ADFirmwareVersionString     "FIRMWARE_VERSION"      
#define ADAcquireString             "ACQUIRE"               
#define ADAcquireBusyString         "ACQUIRE_BUSY"          
#define ADWaitForPluginsString      "WAIT_FOR_PLUGINS"      
/* Parameters defining characteristics of the array data from the detector.
 * NDArraySizeX and NDArraySizeY are the actual dimensions of the array data,
 * including effects of the region definition and binning */
#define NDArraySizeXString      "ARRAY_SIZE_X"      
#define NDArraySizeYString      "ARRAY_SIZE_Y"      
#define NDArraySizeZString      "ARRAY_SIZE_Z"      
#define NDArraySizeString       "ARRAY_SIZE"        
#define NDNDimensionsString     "ARRAY_NDIMENSIONS" 
#define NDDimensionsString      "ARRAY_DIMENSIONS"  
#define NDDataTypeString        "DATA_TYPE"         
#define NDColorModeString       "COLOR_MODE"        
#define NDUniqueIdString        "UNIQUE_ID"         
#define NDTimeStampString       "TIME_STAMP"        
#define NDEpicsTSSecString      "EPICS_TS_SEC"      
#define NDEpicsTSNsecString     "EPICS_TS_NSEC"     
#define NDBayerPatternString    "BAYER_PATTERN"     
#define NDCodecString           "CODEC"             
#define NDCompressedSizeString  "COMPRESSED_SIZE"   
/* Statistics on number of arrays collected */
#define NDArrayCounterString    "ARRAY_COUNTER"     
/* File name related parameters for saving data.
 * Drivers are not required to implement file saving, but if they do these parameters
 * should be used.
 * The driver will normally combine NDFilePath, NDFileName, and NDFileNumber into
 * a file name that order using the format specification in NDFileTemplate.
 * For example NDFileTemplate might be "%s%s_%d.tif" */
#define NDFilePathString        "FILE_PATH"         
#define NDFilePathExistsString  "FILE_PATH_EXISTS"  
#define NDFileNameString        "FILE_NAME"         
#define NDFileNumberString      "FILE_NUMBER"       
#define NDFileTemplateString    "FILE_TEMPLATE"     
#define NDAutoIncrementString   "AUTO_INCREMENT"    
#define NDFullFileNameString    "FULL_FILE_NAME"    
#define NDFileFormatString      "FILE_FORMAT"       
#define NDAutoSaveString        "AUTO_SAVE"         
#define NDWriteFileString       "WRITE_FILE"        
#define NDReadFileString        "READ_FILE"         
#define NDFileWriteModeString   "WRITE_MODE"        
#define NDFileWriteStatusString "WRITE_STATUS"      
#define NDFileWriteMessageString "WRITE_MESSAGE"    
#define NDFileNumCaptureString  "NUM_CAPTURE"       
#define NDFileNumCapturedString "NUM_CAPTURED"      
#define NDFileCaptureString     "CAPTURE"           
#define NDFileDeleteDriverFileString  "DELETE_DRIVER_FILE"  
#define NDFileLazyOpenString    "FILE_LAZY_OPEN"    
#define NDFileCreateDirString   "CREATE_DIR"        
#define NDFileTempSuffixString  "FILE_TEMP_SUFFIX"  
#define NDAttributesFileString    "ND_ATTRIBUTES_FILE"   
#define NDAttributesStatusString  "ND_ATTRIBUTES_STATUS" 
#define NDAttributesMacrosString  "ND_ATTRIBUTES_MACROS" 
/* The detector array data */
#define NDArrayDataString       "ARRAY_DATA"        
#define NDArrayCallbacksString  "ARRAY_CALLBACKS"   
/* NDArray Pool status and control */
#define NDPoolMaxBuffersString      "POOL_MAX_BUFFERS"
#define NDPoolAllocBuffersString    "POOL_ALLOC_BUFFERS"
#define NDPoolFreeBuffersString     "POOL_FREE_BUFFERS"
#define NDPoolMaxMemoryString       "POOL_MAX_MEMORY"
#define NDPoolUsedMemoryString      "POOL_USED_MEMORY"
#define NDPoolEmptyFreeListString   "POOL_EMPTY_FREELIST"

/* Queued arrays */
#define NDNumQueuedArraysString     "NUM_QUEUED_ARRAYS"

class ADCORE_API asynNDArrayDriver : public asynPortDriver {
public:
    asynNDArrayDriver(const char *portName, int maxAddr, int maxBuffers, size_t maxMemory,
                      int interfaceMask, int interruptMask,
                      int asynFlags, int autoConnect, int priority, int stackSize);
    virtual ~asynNDArrayDriver();
    /* These are the methods that we override from asynPortDriver */
    virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t maxChars,
                          size_t *nActual);
    virtual asynStatus readGenericPointer(asynUser *pasynUser, void *genericPointer);
    virtual asynStatus writeGenericPointer(asynUser *pasynUser, void *genericPointer);
    virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
    virtual asynStatus setIntegerParam(int index, int value);
    virtual asynStatus setIntegerParam(int list, int index, int value);
    virtual asynStatus readInt32(asynUser *pasynUser, epicsInt32 *value);
    virtual asynStatus readFloat64(asynUser *pasynUser, epicsFloat64 *value);
    virtual void report(FILE *fp, int details);

    /* These are the methods that are new to this class */
    virtual asynStatus createFilePath(const char *path, int pathDepth);
    virtual asynStatus checkPath();
    virtual bool checkPath(std::string &filePath);
    virtual asynStatus createFileName(int maxChars, char *fullFileName);
    virtual asynStatus createFileName(int maxChars, char *filePath, char *fileName);
    virtual asynStatus readNDAttributesFile();
    virtual asynStatus getAttributes(NDAttributeList *pAttributeList);

    asynStatus incrementQueuedArrayCount();
    asynStatus decrementQueuedArrayCount();
    int getQueuedArrayCount();
    void updateQueuedArrayCount();

    class NDArrayPool *pNDArrayPool;     
protected:
    int NDPortNameSelf;
    #define FIRST_NDARRAY_PARAM 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 NDFileCapture;
    int NDFileDeleteDriverFile;
    int NDFileLazyOpen;
    int NDFileCreateDir;
    int NDFileTempSuffix;
    int NDAttributesFile;
    int NDAttributesStatus;
    int NDAttributesMacros;
    int NDArrayData;
    int NDArrayCallbacks;
    int NDPoolMaxBuffers;
    int NDPoolAllocBuffers;
    int NDPoolFreeBuffers;
    int NDPoolMaxMemory;
    int NDPoolUsedMemory;
    int NDPoolEmptyFreeList;
    int NDNumQueuedArrays;

    class NDArray **pArrays;             
    class NDAttributeList *pAttributeList;  
    int threadStackSize_;
    int threadPriority_;

private:
    NDArrayPool *pNDArrayPoolPvt_;
    epicsMutex *queuedArrayCountMutex_;
    epicsEventId queuedArrayEvent_;
    int queuedArrayCount_;

    bool queuedArrayUpdateRun_;
    epicsEventId queuedArrayUpdateDone_;

    friend class NDArrayPool;

};

#endif