areaDetector
3-13
EPICS areaDetector framework
|
Writes NDArrays to files in the netCDF file format. More...
#include <NDFileNetCDF.h>
Public Member Functions | |
NDFileNetCDF (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int priority, int stackSize) | |
Constructor for NDFileNetCDF; parameters are identical to those for NDPluginFile::NDPluginFile, and are passed directly to that base class constructor. More... | |
virtual asynStatus | openFile (const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray) |
Opens a netCDF file. More... | |
virtual asynStatus | readFile (NDArray **pArray) |
Read NDArray data from a netCDF file; NOTE: not implemented yet. More... | |
virtual asynStatus | writeFile (NDArray *pArray) |
Writes NDArray data to a netCDF file. More... | |
virtual asynStatus | closeFile () |
Closes the netCDF file opened with NDFileNetCDF::openFile. More... | |
Public Member Functions inherited from NDPluginFile | |
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) | |
Constructor for NDPluginFile; all parameters are simply passed to NDPluginDriver::NDPluginDriver. More... | |
virtual void | processCallbacks (NDArray *pArray) |
Callback function that is called by the NDArray driver with new NDArray data. More... | |
virtual asynStatus | writeInt32 (asynUser *pasynUser, epicsInt32 value) |
Called when asyn clients call pasynInt32->write(). More... | |
virtual asynStatus | writeNDArray (asynUser *pasynUser, void *genericPointer) |
Public Member Functions inherited from NDPluginDriver | |
NDPluginDriver (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) | |
Constructor for NDPluginDriver; most parameters are simply passed to asynNDArrayDriver::asynNDArrayDriver. More... | |
~NDPluginDriver () | |
virtual asynStatus | writeFloat64 (asynUser *pasynUser, epicsFloat64 value) |
Called when asyn clients call pasynFloat64->write(). More... | |
virtual asynStatus | writeOctet (asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual) |
Called when asyn clients call pasynOctet->write(). More... | |
virtual asynStatus | readInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn) |
Called when asyn clients call pasynInt32Array->read(). More... | |
virtual void | driverCallback (asynUser *pasynUser, void *genericPointer) |
Method that is called from the driver with a new NDArray. More... | |
virtual void | run (void) |
Starts the thread that receives NDArrays from the epicsMessageQueue. More... | |
virtual asynStatus | start (void) |
Starts the plugin threads. More... | |
void | sortingTask () |
Method runs as a separate thread, periodically doing NDArray callbacks to downstream plugins. More... | |
Public Member Functions inherited from asynNDArrayDriver | |
asynNDArrayDriver (const char *portName, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) | |
This is the constructor for the asynNDArrayDriver class. More... | |
virtual | ~asynNDArrayDriver () |
virtual asynStatus | readGenericPointer (asynUser *pasynUser, void *genericPointer) |
This method copies an NDArray object from the asynNDArrayDriver to an NDArray pointer passed in by the caller. More... | |
virtual asynStatus | writeGenericPointer (asynUser *pasynUser, void *genericPointer) |
This method currently does nothing, but it should be implemented in this base class. More... | |
virtual asynStatus | setIntegerParam (int index, int value) |
Sets the value for an integer in the parameter library. More... | |
virtual asynStatus | setIntegerParam (int list, int index, int value) |
Sets the value for an integer in the parameter library. More... | |
virtual void | report (FILE *fp, int details) |
Report status of the driver. More... | |
virtual asynStatus | createFilePath (const char *path, int pathDepth) |
Function to create a directory path for a file. More... | |
virtual asynStatus | checkPath () |
Checks whether the directory specified NDFilePath parameter exists. More... | |
virtual bool | checkPath (std::string &filePath) |
Checks whether the directory specified exists. More... | |
virtual asynStatus | createFileName (int maxChars, char *fullFileName) |
Build a file name from component parts. More... | |
virtual asynStatus | createFileName (int maxChars, char *filePath, char *fileName) |
Build a file name from component parts. More... | |
virtual asynStatus | readNDAttributesFile () |
Create this driver's NDAttributeList (pAttributeList) by reading an XML file This clears any existing attributes from this drivers' NDAttributeList and then creates a new list based on the XML file. More... | |
virtual asynStatus | getAttributes (NDAttributeList *pAttributeList) |
Get the current values of attributes from this driver and appends them to an output attribute list. More... | |
virtual void | updateTimeStamps (NDArray *pArray) |
asynStatus | incrementQueuedArrayCount () |
asynStatus | decrementQueuedArrayCount () |
int | getQueuedArrayCount () |
void | updateQueuedArrayCount () |
Writes NDArrays to files in the netCDF file format.
netCDF is an open-source, portable, self-describing binary format supported by Unidata at UCAR (http://www.unidata.ucar.edu/software/netcdf). The netCDF format supports arrays of any dimension and all of the data types supported by NDArray. It can store multiple NDArrays in a single file, so it sets NDPluginFile::supportsMultipleArrays to 1. If also can store all of the attributes associated with an NDArray. This class implements the 4 pure virtual functions from NDPluginFile: openFile, readFile, writeFile and closeFile.
NDFileNetCDF::NDFileNetCDF | ( | const char * | portName, |
int | queueSize, | ||
int | blockingCallbacks, | ||
const char * | NDArrayPort, | ||
int | NDArrayAddr, | ||
int | priority, | ||
int | stackSize | ||
) |
Constructor for NDFileNetCDF; parameters are identical to those for NDPluginFile::NDPluginFile, and are passed directly to that base class constructor.
After calling the base class constructor this method sets NDPluginFile::supportsMultipleArrays=1.
|
virtual |
Closes the netCDF file opened with NDFileNetCDF::openFile.
Implements NDPluginFile.
|
virtual |
Opens a netCDF file.
In write mode if NDFileModeMultiple is set then the first dimension is set to NC_UNLIMITED to allow multiple arrays to be written to the same file. NOTE: Does not currently support NDFileModeRead or NDFileModeAppend.
[in] | fileName | Absolute path name of the file to open. |
[in] | openMode | Bit mask with one of the access mode bits NDFileModeRead, NDFileModeWrite, NDFileModeAppend. May also have the bit NDFileModeMultiple set if the file is to be opened to write or read multiple NDArrays into a single file. |
[in] | pArray | Pointer to an NDArray; this array is used to determine the header information and data structure for the file. |
Implements NDPluginFile.
|
virtual |
Read NDArray data from a netCDF file; NOTE: not implemented yet.
[in] | pArray | Pointer to the address of an NDArray to read the data into. |
Implements NDPluginFile.
|
virtual |
Writes NDArray data to a netCDF file.
[in] | pArray | Pointer to an NDArray to write to the file. This function can be called multiple times between the call to openFile and closeFile if NDFileModeMultiple was set in openMode in the call to NDFileNetCDF::openFile. |
Implements NDPluginFile.