areaDetector  3-13
EPICS areaDetector framework
NDFileNull.h
Go to the documentation of this file.
1 /*
2  * NDFileNull.h
3  * Dummy file writer, whose main purpose is to allow deleting original driver files without re-writing them in
4  * an actual file plugin.
5  *
6  * Mark Rivers
7  * November 30, 2011
8  */
9 
10 #ifndef DRV_NDFileNULL_H
11 #define DRV_NDFileNULL_H
12 
13 #include "NDPluginFile.h"
14 
18 public:
19  NDFileNull(const char *portName, int queueSize, int blockingCallbacks,
20  const char *NDArrayPort, int NDArrayAddr,
21  int priority, int stackSize);
22 
23  /* The methods that this class implements */
24  virtual asynStatus openFile(const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray);
25  virtual asynStatus readFile(NDArray **pArray);
26  virtual asynStatus writeFile(NDArray *pArray);
27  virtual asynStatus closeFile();
28 };
29 
30 #endif
#define NDPLUGIN_API
Definition: NDPluginAPI.h:41
int NDFileOpenMode_t
Definition: NDPluginFile.h:17
N-dimensional array class; each array has a set of dimensions, a data type, pointer to data,...
Definition: NDArray.h:99
Writes NDArrays in the Null file format.
Definition: NDFileNull.h:17
Base class for NDArray file writing plugins; actual file writing plugins inherit from this class.
Definition: NDPluginFile.h:28
virtual asynStatus readFile(NDArray **pArray)=0
Read NDArray data from a file; pure virtual function that must be implemented by derived classes.
virtual asynStatus closeFile()=0
Close the file opened with NDPluginFile::openFile; pure virtual function that must be implemented by ...
virtual asynStatus openFile(const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray)=0
Open a file; pure virtual function that must be implemented by derived classes.
virtual asynStatus writeFile(NDArray *pArray)=0
Write NDArray data to a file; pure virtual function that must be implemented by derived classes.