Writes NDArrays to files in the netCDF file format. More...
#include <NDFileNetCDF.h>
Inheritance diagram for NDFileNetCDF:
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 | readInt32 (asynUser *pasynUser, epicsInt32 *value) |
| Called when asyn clients call pasynInt32->read(). More... | |
| virtual asynStatus | readFloat64 (asynUser *pasynUser, epicsFloat64 *value) |
| Called when asyn clients call pasynFloat64->read(). 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... | |
| asynStatus | incrementQueuedArrayCount () |
| asynStatus | decrementQueuedArrayCount () |
| int | getQueuedArrayCount () |
| void | updateQueuedArrayCount () |
| Public Member Functions inherited from asynPortDriver | |
| asynPortDriver (const char *portName, int maxAddr, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) | |
| Constructor for the asynPortDriver class. More... | |
| asynPortDriver (const char *portName, int maxAddr, int paramTableSize, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) EPICS_DEPRECATED | |
| Legacy constructor for the asynPortDriver class (DEPRECATED - please use the one above instead). More... | |
| virtual | ~asynPortDriver () |
| Destructor for asynPortDriver class; frees resources allocated when port driver is created. More... | |
| virtual asynStatus | lock () |
| Locks the driver to prevent multiple threads from accessing memory at the same time. More... | |
| virtual asynStatus | unlock () |
| Unlocks the driver; called when an asyn client or driver is done accessing common memory. More... | |
| virtual asynStatus | getAddress (asynUser *pasynUser, int *address) |
| Returns the asyn address associated with a pasynUser structure. More... | |
| virtual asynStatus | readUInt32Digital (asynUser *pasynUser, epicsUInt32 *value, epicsUInt32 mask) |
| Called when asyn clients call pasynUInt32Digital->read(). More... | |
| virtual asynStatus | writeUInt32Digital (asynUser *pasynUser, epicsUInt32 value, epicsUInt32 mask) |
| Called when asyn clients call pasynUInt32Digital->write(). More... | |
| virtual asynStatus | setInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 mask, interruptReason reason) |
| Called when asyn clients call pasynUInt32Digital->setInterrupt(). More... | |
| virtual asynStatus | clearInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 mask) |
| Called when asyn clients call pasynUInt32Digital->clearInterrupt(). More... | |
| virtual asynStatus | getInterruptUInt32Digital (asynUser *pasynUser, epicsUInt32 *mask, interruptReason reason) |
| Called when asyn clients call pasynUInt32Digital->getInterrupt(). More... | |
| virtual asynStatus | getBounds (asynUser *pasynUser, epicsInt32 *low, epicsInt32 *high) |
| Called when asyn clients call pasynInt32->getBounds(), returning the bounds on the asynInt32 interface for drivers that use raw units. More... | |
| virtual asynStatus | readOctet (asynUser *pasynUser, char *value, size_t maxChars, size_t *nActual, int *eomReason) |
| Called when asyn clients call pasynOctet->read(). More... | |
| virtual asynStatus | flushOctet (asynUser *pasynUser) |
| Called when asyn clients call pasynOctet->flush(). More... | |
| virtual asynStatus | setInputEosOctet (asynUser *pasynUser, const char *eos, int eosLen) |
| Called when asyn clients call pasynOctet->setInputEos(). More... | |
| virtual asynStatus | getInputEosOctet (asynUser *pasynUser, char *eos, int eosSize, int *eosLen) |
| Called when asyn clients call pasynOctet->getInputEos(). More... | |
| virtual asynStatus | setOutputEosOctet (asynUser *pasynUser, const char *eos, int eosLen) |
| Called when asyn clients call pasynOctet->setOutputEos(). More... | |
| virtual asynStatus | getOutputEosOctet (asynUser *pasynUser, char *eos, int eosSize, int *eosLen) |
| Called when asyn clients call pasynOctet->getOutputEos(). More... | |
| virtual asynStatus | readInt8Array (asynUser *pasynUser, epicsInt8 *value, size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynInt8Array->read(). More... | |
| virtual asynStatus | writeInt8Array (asynUser *pasynUser, epicsInt8 *value, size_t nElements) |
| Called when asyn clients call pasynInt8Array->write(). More... | |
| virtual asynStatus | doCallbacksInt8Array (epicsInt8 *value, size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynInt8Array interface. More... | |
| virtual asynStatus | readInt16Array (asynUser *pasynUser, epicsInt16 *value, size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynInt16Array->read(). More... | |
| virtual asynStatus | writeInt16Array (asynUser *pasynUser, epicsInt16 *value, size_t nElements) |
| Called when asyn clients call pasynInt16Array->write(). More... | |
| virtual asynStatus | doCallbacksInt16Array (epicsInt16 *value, size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynInt16Array interface. More... | |
| virtual asynStatus | writeInt32Array (asynUser *pasynUser, epicsInt32 *value, size_t nElements) |
| Called when asyn clients call pasynInt32Array->write(). More... | |
| virtual asynStatus | doCallbacksInt32Array (epicsInt32 *value, size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynInt32Array interface. More... | |
| virtual asynStatus | readFloat32Array (asynUser *pasynUser, epicsFloat32 *value, size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynFloat32Array->read(). More... | |
| virtual asynStatus | writeFloat32Array (asynUser *pasynUser, epicsFloat32 *value, size_t nElements) |
| Called when asyn clients call pasynFloat32Array->write(). More... | |
| virtual asynStatus | doCallbacksFloat32Array (epicsFloat32 *value, size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynFloat32Array interface. More... | |
| virtual asynStatus | readFloat64Array (asynUser *pasynUser, epicsFloat64 *value, size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynFloat64Array->read(). More... | |
| virtual asynStatus | writeFloat64Array (asynUser *pasynUser, epicsFloat64 *value, size_t nElements) |
| Called when asyn clients call pasynFloat64Array->write(). More... | |
| virtual asynStatus | doCallbacksFloat64Array (epicsFloat64 *value, size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynFloat64Array interface. More... | |
| virtual asynStatus | doCallbacksGenericPointer (void *pointer, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynGenericPointer interface. More... | |
| virtual asynStatus | readOption (asynUser *pasynUser, const char *key, char *value, int maxChars) |
| Called when asyn clients call pasynOption->read(). More... | |
| virtual asynStatus | writeOption (asynUser *pasynUser, const char *key, const char *value) |
| Called when asyn clients call pasynOption->write(). More... | |
| virtual asynStatus | readEnum (asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements, size_t *nIn) |
| Called when asyn clients call pasynEnum->read(). More... | |
| virtual asynStatus | writeEnum (asynUser *pasynUser, char *strings[], int values[], int severities[], size_t nElements) |
| Called when asyn clients call pasynEnum->write(). More... | |
| virtual asynStatus | doCallbacksEnum (char *strings[], int values[], int severities[], size_t nElements, int reason, int addr) |
| Called by driver to do the callbacks to registered clients on the asynEnum interface. More... | |
| virtual asynStatus | drvUserCreate (asynUser *pasynUser, const char *drvInfo, const char **pptypeName, size_t *psize) |
| Called by asynManager to pass a pasynUser structure and drvInfo string to the driver; Assigns pasynUser->reason based on the value of the drvInfo string. More... | |
| virtual asynStatus | drvUserGetType (asynUser *pasynUser, const char **pptypeName, size_t *psize) |
| Returns strings associated with driver-specific commands. More... | |
| virtual asynStatus | drvUserDestroy (asynUser *pasynUser) |
| Frees any resources allocated by drvUserCreate. More... | |
| virtual asynStatus | connect (asynUser *pasynUser) |
| Connects driver to device; The base class implementation simply calls pasynManager->exceptionConnect if address is valid Derived classes can reimplement this function for real connection management. More... | |
| virtual asynStatus | disconnect (asynUser *pasynUser) |
| Disconnects driver from device; the base class implementation simply calls pasynManager->exceptionDisconnect. More... | |
| virtual asynStatus | createParam (const char *name, asynParamType type, int *index) |
| Creates a parameter in the parameter library. More... | |
| virtual asynStatus | createParam (int list, const char *name, asynParamType type, int *index) |
| Creates a parameter in the parameter library. More... | |
| virtual asynStatus | getNumParams (int *numParams) |
| Returns the number of parameters in the parameter library. More... | |
| virtual asynStatus | getNumParams (int list, int *numParams) |
| Returns the number of parameters in the parameter library. More... | |
| virtual asynStatus | findParam (const char *name, int *index) |
| Finds a parameter in the parameter library. More... | |
| virtual asynStatus | findParam (int list, const char *name, int *index) |
| Finds a parameter in the parameter library. More... | |
| virtual asynStatus | getParamName (int index, const char **name) |
| Returns the name of a parameter in the parameter library. More... | |
| virtual asynStatus | getParamName (int list, int index, const char **name) |
| Returns the name of a parameter in the parameter library. More... | |
| virtual asynStatus | getParamType (int index, asynParamType *type) |
| Returns the asynParamType of a parameter in the parameter library*. More... | |
| virtual asynStatus | getParamType (int list, int index, asynParamType *type) |
| Returns the asynParamType of a parameter in the parameter library. More... | |
| virtual asynStatus | setParamStatus (int index, asynStatus status) |
| Sets the status for a parameter in the parameter library. More... | |
| virtual asynStatus | setParamStatus (int list, int index, asynStatus status) |
| Sets the status for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamStatus (int index, asynStatus *status) |
| Gets the status for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamStatus (int list, int index, asynStatus *status) |
| Gets the status for a parameter in the parameter library. More... | |
| virtual asynStatus | setParamAlarmStatus (int index, int status) |
| Sets the alarmStatus for a parameter in the parameter library. More... | |
| virtual asynStatus | setParamAlarmStatus (int list, int index, int status) |
| Sets the alarmStatus for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamAlarmStatus (int index, int *status) |
| Gets the alarmStatus for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamAlarmStatus (int list, int index, int *status) |
| Gets the alarmStatus for a parameter in the parameter library. More... | |
| virtual asynStatus | setParamAlarmSeverity (int index, int severity) |
| Sets the alarmSeverity for a parameter in the parameter library. More... | |
| virtual asynStatus | setParamAlarmSeverity (int list, int index, int severity) |
| Sets the alarmSeverity for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamAlarmSeverity (int index, int *severity) |
| Gets the alarmSeverity for a parameter in the parameter library. More... | |
| virtual asynStatus | getParamAlarmSeverity (int list, int index, int *severity) |
| Gets the alarmSeverity for a parameter in the parameter library. More... | |
| virtual void | reportSetParamErrors (asynStatus status, int index, int list, const char *functionName) |
| Reports errors when setting parameters. More... | |
| virtual void | reportGetParamErrors (asynStatus status, int index, int list, const char *functionName) |
| Reports errors when getting parameters. 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 | setUIntDigitalParam (int index, epicsUInt32 value, epicsUInt32 valueMask) |
| Sets the value for a UInt32Digital in the parameter library. More... | |
| virtual asynStatus | setUIntDigitalParam (int list, int index, epicsUInt32 value, epicsUInt32 valueMask) |
| Sets the value for a UInt32Digital in the parameter library. More... | |
| virtual asynStatus | setUIntDigitalParam (int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask) |
| Sets the value for a UInt32Digital in the parameter library. More... | |
| virtual asynStatus | setUIntDigitalParam (int list, int index, epicsUInt32 value, epicsUInt32 valueMask, epicsUInt32 interruptMask) |
| Sets the value for a UInt32Digital in the parameter library. More... | |
| virtual asynStatus | setUInt32DigitalInterrupt (int index, epicsUInt32 mask, interruptReason reason) |
| Sets the interrupt mask and reason in the parameter library Calls paramList::setUInt32Interrupt (0, index, mask, reason) i.e. More... | |
| virtual asynStatus | setUInt32DigitalInterrupt (int list, int index, epicsUInt32 mask, interruptReason reason) |
| Sets the interrupt mask and reason in the parameter library Calls paramList::setUInt32Interrupt (index, mask, reason) for the parameter list indexed by list. More... | |
| virtual asynStatus | clearUInt32DigitalInterrupt (int index, epicsUInt32 mask) |
| Clears the interrupt mask in the parameter library Calls paramList::clearUInt32Interrupt (0, index, mask) i.e. More... | |
| virtual asynStatus | clearUInt32DigitalInterrupt (int list, int index, epicsUInt32 mask) |
| Clears the interrupt mask in the parameter library Calls paramList::clearUInt32Interrupt (index, mask) for the parameter list indexed by list. More... | |
| virtual asynStatus | getUInt32DigitalInterrupt (int index, epicsUInt32 *mask, interruptReason reason) |
| Gets the interrupt mask and reason in the parameter library Calls paramList::getUInt32Interrupt (0, index, mask, reason) i.e. More... | |
| virtual asynStatus | getUInt32DigitalInterrupt (int list, int index, epicsUInt32 *mask, interruptReason reason) |
| Gets the interrupt mask and reason in the parameter library Calls paramList::getUInt32Interrupt (index, mask, reason) for the parameter list indexed by list. More... | |
| virtual asynStatus | setDoubleParam (int index, double value) |
| Sets the value for a double in the parameter library. More... | |
| virtual asynStatus | setDoubleParam (int list, int index, double value) |
| Sets the value for a double in the parameter library. More... | |
| virtual asynStatus | setStringParam (int index, const char *value) |
| Sets the value for a string in the parameter library. More... | |
| virtual asynStatus | setStringParam (int list, int index, const char *value) |
| Sets the value for a string in the parameter library. More... | |
| virtual asynStatus | setStringParam (int index, const std::string &value) |
| Sets the value for a string in the parameter library. More... | |
| virtual asynStatus | setStringParam (int list, int index, const std::string &value) |
| Sets the value for a string in the parameter library. More... | |
| virtual asynStatus | getIntegerParam (int index, epicsInt32 *value) |
| Returns the value for an integer from the parameter library. More... | |
| virtual asynStatus | getIntegerParam (int list, int index, epicsInt32 *value) |
| Returns the value for an integer from the parameter library. More... | |
| virtual asynStatus | getUIntDigitalParam (int index, epicsUInt32 *value, epicsUInt32 mask) |
| Returns the value for an UInt32Digital parameter from the parameter library. More... | |
| virtual asynStatus | getUIntDigitalParam (int list, int index, epicsUInt32 *value, epicsUInt32 mask) |
| Returns the value for an UInt32Digital parameter from the parameter library. More... | |
| virtual asynStatus | getDoubleParam (int index, double *value) |
| Returns the value for a double from the parameter library. More... | |
| virtual asynStatus | getDoubleParam (int list, int index, double *value) |
| Returns the value for a double from the parameter library. More... | |
| virtual asynStatus | getStringParam (int index, int maxChars, char *value) |
| Returns the value for a string from the parameter library. More... | |
| virtual asynStatus | getStringParam (int list, int index, int maxChars, char *value) |
| Returns the value for a string from the parameter library. More... | |
| virtual asynStatus | getStringParam (int index, std::string &value) |
| Returns the value for a string from the parameter library. More... | |
| virtual asynStatus | getStringParam (int list, int index, std::string &value) |
| Returns the value for a string from the parameter library. More... | |
| virtual asynStatus | callParamCallbacks () |
| Calls callParamCallbacks(0, 0) i.e. More... | |
| virtual asynStatus | callParamCallbacks (int addr) |
| Calls callParamCallbacks(addr, addr) i.e. More... | |
| virtual asynStatus | callParamCallbacks (int list, int addr) |
| Calls paramList::callCallbacks(addr) for a specific parameter list. More... | |
| virtual asynStatus | updateTimeStamp () |
| Updates the timestamp for this port in pasynManager. More... | |
| virtual asynStatus | updateTimeStamp (epicsTimeStamp *pTimeStamp) |
| Updates the timestamp for this port in pasynManager, and returns this timestamp. More... | |
| virtual asynStatus | getTimeStamp (epicsTimeStamp *pTimeStamp) |
| Gets the most recent timestamp for this port from pasynManager. More... | |
| virtual asynStatus | setTimeStamp (const epicsTimeStamp *pTimeStamp) |
| Sets the timestamp for this port in pasynManager. More... | |
| asynStandardInterfaces * | getAsynStdInterfaces () |
| Returns the asynStdInterfaces structure used by asynPortDriver. More... | |
| virtual void | reportParams (FILE *fp, int details) |
| Calls paramList::report(fp, details) for each parameter list that the driver supports. More... | |
| void | callbackTask () |
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 NDArrayPool * | pNDArrayPool |
| An NDArrayPool pointer that is initialized to pNDArrayPoolPvt_ in the constructor. More... | |
| Public Attributes inherited from asynPortDriver | |
| char * | portName |
| The name of this asyn port. More... | |
| int | maxAddr |
| The maximum asyn address (addr) supported by this driver. 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 Member Functions inherited from asynPortDriver | |
| void | initialize (const char *portNameIn, int maxAddrIn, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize) |
| The following function is required to initialize from two constructors. More... | |
| 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 |
| NDArray * | pPrevInputArray_ |
| Protected Attributes inherited from asynNDArrayDriver | |
| int | NDPortNameSelf |
| int | NDADCoreVersion |
| int | NDDriverVersion |
| 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 NDAttributeList * | pAttributeList |
| An NDAttributeList object used to obtain the current values of a set of attributes. More... | |
| int | threadStackSize_ |
| int | threadPriority_ |
| Protected Attributes inherited from asynPortDriver | |
| asynUser * | pasynUserSelf |
| asynUser connected to ourselves for asynTrace More... | |
| asynStandardInterfaces | asynStdInterfaces |
| The asyn interfaces this driver implements. More... | |
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()
|
virtual |
Closes the netCDF file opened with NDFileNetCDF::openFile.
Implements NDPluginFile.
◆ openFile()
|
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] 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.
◆ readFile()
|
virtual |
Read NDArray data from a netCDF file; NOTE: not implemented yet.
- Parameters
-
[in] pArray Pointer to the address of an NDArray to read the data into.
Implements NDPluginFile.
◆ writeFile()
|
virtual |
Writes NDArray data to a netCDF file.
- Parameters
-
[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.
The documentation for this class was generated from the following files:
- /home/epics/devel/areaDetector-3-5/ADCore/ADApp/pluginSrc/NDFileNetCDF.h
- /home/epics/devel/areaDetector-3-5/ADCore/ADApp/pluginSrc/NDFileNetCDF.cpp
