NDPluginFile.h

Go to the documentation of this file.

#ifndef NDPluginFile_H
#define NDPluginFile_H

#include <epicsTypes.h>
#include <epicsMutex.h>

#include "NDPluginDriver.h"

#define NDFileModeRead     0x01

#define NDFileModeWrite    0x02

#define NDFileModeAppend   0x04

#define NDFileModeMultiple 0x08
typedef int NDFileOpenMode_t;

#define FILEPLUGIN_NAME        "FilePluginFileName"
#define FILEPLUGIN_NUMBER      "FilePluginFileNumber"
#define FILEPLUGIN_DESTINATION "FilePluginDestination"
#define FILEPLUGIN_CLOSE       "FilePluginClose"

class epicsShareClass NDPluginFile : public NDPluginDriver {
public:
    NDPluginFile(const char *portName, int queueSize, int blockingCallbacks, 
                 const char *NDArrayPort, int NDArrayAddr, int maxAddr,
                 int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask,
                 int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads,
                 bool compressionAware = false);
                 
    /* These methods override those in the base class */
    virtual void processCallbacks(NDArray *pArray);
    virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value);
    virtual asynStatus writeNDArray(asynUser *pasynUser, void *genericPointer);

    virtual asynStatus openFile(const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray) = 0;

    virtual asynStatus readFile(NDArray **pArray) = 0;

    virtual asynStatus writeFile(NDArray *pArray) = 0;

    virtual asynStatus closeFile() = 0;
    
    int supportsMultipleArrays; 
private:
    asynStatus openFileBase(NDFileOpenMode_t openMode, NDArray *pArray);
    asynStatus readFileBase();
    asynStatus writeFileBase();
    asynStatus closeFileBase();
    asynStatus doCapture(int capture);
    void       freeCaptureBuffer(int numCapture);
    asynStatus attrFileCloseCheck();
    asynStatus attrFileNameCheck();
    asynStatus attrFileNameSet();
    bool attrIsProcessingRequired(NDAttributeList* pAttrList);
    void registerInitFrameInfo(NDArray *pArray); 
    bool isFrameValid(NDArray *pArray); 
    NDArray **pCapture;
    int captureBufferSize;
    epicsMutexId fileMutexId;
    bool useAttrFilePrefix;
    bool lazyOpen;
    NDArrayInfo_t *ndArrayInfoInit; 
};

#endif