areaDetector  3-12-1
EPICS areaDetector framework
Public Member Functions | List of all members
NDFileNetCDF Class Reference

Writes NDArrays to files in the netCDF file format. More...

#include <NDFileNetCDF.h>

Inheritance diagram for NDFileNetCDF:
NDPluginFile NDPluginDriver asynNDArrayDriver

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 asynStatus readInt32 (asynUser *pasynUser, epicsInt32 *value)
 
virtual asynStatus readFloat64 (asynUser *pasynUser, epicsFloat64 *value)
 
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...
 
asynStatus incrementQueuedArrayCount ()
 
asynStatus decrementQueuedArrayCount ()
 
int getQueuedArrayCount ()
 
void updateQueuedArrayCount ()
 

Additional Inherited Members

- Public Attributes inherited from NDPluginFile
int supportsMultipleArrays
 Derived classes must set this flag to 0/1 if they cannot/can write multiple NDArrays to a single file. More...
 
- Public Attributes inherited from asynNDArrayDriver
class NDArrayPoolpNDArrayPool
 An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More...
 
- Protected Member Functions inherited from NDPluginDriver
virtual void beginProcessCallbacks (NDArray *pArray)
 Method that is normally called at the beginning of the processCallbacks method in derived classes. More...
 
virtual asynStatus endProcessCallbacks (NDArray *pArray, bool copyArray=false, bool readAttributes=true)
 Method that is normally called at the end of the processCallbacks()) method in derived classes. More...
 
virtual asynStatus connectToArrayPort (void)
 Connect this plugin to an NDArray port driver; disconnect from any existing driver first, register for callbacks if enabled. More...
 
virtual asynStatus setArrayInterrupt (int connect)
 Register or unregister to receive asynGenericPointer (NDArray) callbacks from the driver. More...
 
bool throttled (NDArray *pArray)
 
- Protected Attributes inherited from NDPluginDriver
int NDPluginDriverArrayPort
 
int NDPluginDriverArrayAddr
 
int NDPluginDriverPluginType
 
int NDPluginDriverDroppedArrays
 
int NDPluginDriverQueueSize
 
int NDPluginDriverQueueFree
 
int NDPluginDriverMaxThreads
 
int NDPluginDriverNumThreads
 
int NDPluginDriverSortMode
 
int NDPluginDriverSortTime
 
int NDPluginDriverSortSize
 
int NDPluginDriverSortFree
 
int NDPluginDriverDisorderedArrays
 
int NDPluginDriverDroppedOutputArrays
 
int NDPluginDriverEnableCallbacks
 
int NDPluginDriverBlockingCallbacks
 
int NDPluginDriverProcessPlugin
 
int NDPluginDriverExecutionTime
 
int NDPluginDriverMinCallbackTime
 
int NDPluginDriverMaxByteRate
 
NDArraypPrevInputArray_
 
- Protected Attributes inherited from asynNDArrayDriver
int 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
 An array of NDArray pointers used to store data in the driver. More...
 
class NDAttributeListpAttributeList
 An NDAttributeList object used to obtain the current values of a set of attributes. More...
 
int threadStackSize_
 
int threadPriority_
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ NDFileNetCDF()

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.

Member Function Documentation

◆ closeFile()

asynStatus NDFileNetCDF::closeFile ( )
virtual

Closes the netCDF file opened with NDFileNetCDF::openFile.

Implements NDPluginFile.

◆ openFile()

asynStatus NDFileNetCDF::openFile ( const char *  fileName,
NDFileOpenMode_t  openMode,
NDArray pArray 
)
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.

Parameters
[in]fileNameAbsolute path name of the file to open.
[in]openModeBit 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]pArrayPointer to an NDArray; this array is used to determine the header information and data structure for the file.

Implements NDPluginFile.

◆ readFile()

asynStatus NDFileNetCDF::readFile ( NDArray **  pArray)
virtual

Read NDArray data from a netCDF file; NOTE: not implemented yet.

Parameters
[in]pArrayPointer to the address of an NDArray to read the data into.

Implements NDPluginFile.

◆ writeFile()

asynStatus NDFileNetCDF::writeFile ( NDArray pArray)
virtual

Writes NDArray data to a netCDF file.

Parameters
[in]pArrayPointer 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.


The documentation for this class was generated from the following files: