areaDetector  3-7-0
EPICS areaDetector framework
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
NDFileHDF5 Class Reference

Writes NDArrays in the HDF5 file format; an XML file can control the structure of the HDF5 file. More...

#include <NDFileHDF5.h>

Inheritance diagram for NDFileHDF5:
NDPluginFile NDPluginDriver asynNDArrayDriver

Public Member Functions

 NDFileHDF5 (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int priority, int stackSize)
 Constructor for NDFileHDF5; 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 HDF5 file. More...
 
virtual asynStatus readFile (NDArray **pArray)
 Read NDArray data from a HDF5 file; NOTE: not implemented yet. More...
 
virtual asynStatus writeFile (NDArray *pArray)
 Writes NDArray data to a HDF5 file. More...
 
virtual asynStatus closeFile ()
 Closes the HDF5 file opened with NDFileHDF5::openFile. More...
 
virtual void report (FILE *fp, int details)
 Report status of the driver. More...
 
virtual asynStatus writeInt32 (asynUser *pasynUser, epicsInt32 value)
 Perform any actions required when an int32 parameter is updated. More...
 
virtual asynStatus writeOctet (asynUser *pasynUser, const char *value, size_t nChars, size_t *nActual)
 Called when asyn clients call pasynOctet->write(). More...
 
void flushTask ()
 Thread function for flush now command Waits for flush events, and upon receiving one, flushes all datasets and attributes, ensuring that the unique ID attribute is the last attribute flushed. More...
 
asynStatus startSWMR ()
 
asynStatus flushCallback ()
 
asynStatus createXMLFileLayout ()
 Create the groups and datasets in the HDF5 file. More...
 
asynStatus storeOnOpenAttributes ()
 Check through attributes and store any that have been marked as onOpen. More...
 
asynStatus storeOnCloseAttributes ()
 Check through attributes and store any that have been marked as onClose. More...
 
asynStatus storeOnOpenCloseAttribute (hdf5::Element *element, bool open)
 Check attribute and store if marked as onOpen or onClose when opening or closing. More...
 
asynStatus createTree (hdf5::Group *root, hid_t h5handle)
 Create the root group and recursively create all subgroups and datasets in the HDF5 file. More...
 
asynStatus createHardLinks (hdf5::Group *root)
 Create the hardlinks in the HDF5 file. More...
 
hid_t writeHdfConstDataset (hid_t h5_handle, hdf5::Dataset *dset)
 
hid_t writeH5dsetStr (hid_t element, const std::string &name, const std::string &str_value) const
 Write a string constant dataset. More...
 
hid_t writeH5dsetInt32 (hid_t element, const std::string &name, const std::string &str_value) const
 
hid_t writeH5dsetFloat64 (hid_t element, const std::string &name, const std::string &str_value) const
 
void writeHdfAttributes (hid_t h5_handle, hdf5::Element *element)
 Check this element for any attached attributes and write them out. More...
 
hid_t createDataset (hid_t group, hdf5::Dataset *dset)
 Create the dataset and write it out. More...
 
void writeH5attrStr (hid_t element, const std::string &attr_name, const std::string &str_attr_value) const
 Write a string constant attribute. More...
 
void writeH5attrInt32 (hid_t element, const std::string &attr_name, const std::string &str_attr_value) const
 Write an int (or array of ints) constant attribute. More...
 
void writeH5attrFloat64 (hid_t element, const std::string &attr_name, const std::string &str_attr_value) const
 Write a float (or array of floats) constant attribute. More...
 
hid_t fromHdfToHidDatatype (hdf5::DataType_t in) const
 Utility method to convert from hdf5 to hid datatype. More...
 
hid_t createDatasetDetector (hid_t group, hdf5::Dataset *dset)
 Create a dataset in the HDF5 file with the details defined in the dset argument. More...
 
int fileExists (char *filename)
 Check if the specified filename/path exists. More...
 
int verifyLayoutXMLFile ()
 Verify the XML layout file is valid. More...
 
hsize_t getDim (int index)
 Return the requested dimension size. More...
 
hsize_t getMaxDim (int index)
 Return the requested max dimension size. More...
 
hsize_t getChunkDim (int index)
 Return the requested chunk dimension size. More...
 
hsize_t getOffset (int index)
 Return the requested offset size. More...
 
hsize_t getVirtualDim (int index)
 Return the requested virtual dimension size. 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 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 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)
 
virtual asynStatus readFloat64 (asynUser *pasynUser, epicsFloat64 *value)
 
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 Attributes

std::map< std::string, NDFileHDF5Dataset * > detDataMap
 
std::map< std::string, hid_t > attDataMap
 
std::string defDsetName
 
std::string ndDsetName
 
std::map< std::string, hdf5::Element * > onOpenMap
 
std::map< std::string, hdf5::Element * > onCloseMap
 
Codec_t codec
 
- 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...
 

Static Public Attributes

static const char * str_NDFileHDF5_chunkSize [MAX_CHUNK_DIMS]
 
static const char * str_NDFileHDF5_extraDimSize [MAXEXTRADIMS]
 
static const char * str_NDFileHDF5_extraDimName [MAXEXTRADIMS]
 
static const char * str_NDFileHDF5_extraDimChunk [MAXEXTRADIMS]
 
static const char * str_NDFileHDF5_posName [MAXEXTRADIMS]
 
static const char * str_NDFileHDF5_posIndex [MAXEXTRADIMS]
 

Protected Member Functions

asynStatus configureDims (NDArray *pArray)
 Configure the HDF5 dimension definitions based on NDArray dimensions. More...
 
void calcNumFrames ()
 Calculate the total number of frames that the current configured dimensions can contain. More...
 
void setMultiFrameFile (bool multi)
 Set the multi frame parameter. 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

int NDFileHDF5_chunkSizeAuto
 
int NDFileHDF5_nFramesChunks
 
int NDFileHDF5_chunkSize [MAX_CHUNK_DIMS]
 
int NDFileHDF5_chunkBoundaryAlign
 
int NDFileHDF5_chunkBoundaryThreshold
 
int NDFileHDF5_NDAttributeChunk
 
int NDFileHDF5_nExtraDims
 
int NDFileHDF5_extraDimOffsetX
 
int NDFileHDF5_extraDimOffsetY
 
int NDFileHDF5_extraDimSize [MAXEXTRADIMS]
 
int NDFileHDF5_extraDimName [MAXEXTRADIMS]
 
int NDFileHDF5_extraDimChunk [MAXEXTRADIMS]
 
int NDFileHDF5_storeAttributes
 
int NDFileHDF5_storePerformance
 
int NDFileHDF5_totalRuntime
 
int NDFileHDF5_totalIoSpeed
 
int NDFileHDF5_flushNthFrame
 
int NDFileHDF5_compressionType
 
int NDFileHDF5_nbitsPrecision
 
int NDFileHDF5_nbitsOffset
 
int NDFileHDF5_szipNumPixels
 
int NDFileHDF5_zCompressLevel
 
int NDFileHDF5_bloscCompressor
 
int NDFileHDF5_bloscCompressLevel
 
int NDFileHDF5_bloscShuffleType
 
int NDFileHDF5_jpegQuality
 
int NDFileHDF5_dimAttDatasets
 
int NDFileHDF5_layoutErrorMsg
 
int NDFileHDF5_layoutValid
 
int NDFileHDF5_layoutFilename
 
int NDFileHDF5_posRunning
 
int NDFileHDF5_posName [MAXEXTRADIMS]
 
int NDFileHDF5_posIndex [MAXEXTRADIMS]
 
int NDFileHDF5_fillValue
 
int NDFileHDF5_SWMRFlushNow
 
int NDFileHDF5_SWMRCbCounter
 
int NDFileHDF5_SWMRSupported
 
int NDFileHDF5_SWMRMode
 
int NDFileHDF5_SWMRRunning
 
- 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 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 in the HDF5 file format; an XML file can control the structure of the HDF5 file.

Constructor & Destructor Documentation

◆ NDFileHDF5()

NDFileHDF5::NDFileHDF5 ( const char *  portName,
int  queueSize,
int  blockingCallbacks,
const char *  NDArrayPort,
int  NDArrayAddr,
int  priority,
int  stackSize 
)

Constructor for NDFileHDF5; 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

◆ calcNumFrames()

void NDFileHDF5::calcNumFrames ( )
protected

Calculate the total number of frames that the current configured dimensions can contain.

Sets the NDFileNumCapture parameter to the total value so file saving will complete at this number. This is called only from writeInt32 so the lock is already taken.

◆ closeFile()

asynStatus NDFileHDF5::closeFile ( )
virtual

Closes the HDF5 file opened with NDFileHDF5::openFile.

Implements NDPluginFile.

◆ configureDims()

asynStatus NDFileHDF5::configureDims ( NDArray pArray)
protected

Configure the HDF5 dimension definitions based on NDArray dimensions.

Initially this implementation just copies the dimension sizes from the NDArray in the same order. A last infinite length dimension is added if multiple frames are to be stored in the same file (in Capture or Stream mode).

◆ createDataset()

hid_t NDFileHDF5::createDataset ( hid_t  group,
hdf5::Dataset dset 
)

Create the dataset and write it out.

Only detector and constant datasets are created in the file out at this time.

NDAttribute datasets are created elsewhere in createAttributeDatasets()

◆ createDatasetDetector()

hid_t NDFileHDF5::createDatasetDetector ( hid_t  group,
hdf5::Dataset dset 
)

Create a dataset in the HDF5 file with the details defined in the dset argument.

Return the hid_t handle to the new dataset on success; -1 on error. Errors: fail to set chunk size or failure to create the dataset in the file.

◆ createHardLinks()

asynStatus NDFileHDF5::createHardLinks ( hdf5::Group root)

Create the hardlinks in the HDF5 file.

◆ createTree()

asynStatus NDFileHDF5::createTree ( hdf5::Group root,
hid_t  h5handle 
)

Create the root group and recursively create all subgroups and datasets in the HDF5 file.

◆ createXMLFileLayout()

asynStatus NDFileHDF5::createXMLFileLayout ( )

Create the groups and datasets in the HDF5 file.

◆ fileExists()

int NDFileHDF5::fileExists ( char *  filename)

Check if the specified filename/path exists.

◆ flushCallback()

asynStatus NDFileHDF5::flushCallback ( )

◆ flushTask()

void NDFileHDF5::flushTask ( )

Thread function for flush now command Waits for flush events, and upon receiving one, flushes all datasets and attributes, ensuring that the unique ID attribute is the last attribute flushed.

◆ fromHdfToHidDatatype()

hid_t NDFileHDF5::fromHdfToHidDatatype ( hdf5::DataType_t  in) const

Utility method to convert from hdf5 to hid datatype.

◆ getChunkDim()

hsize_t NDFileHDF5::getChunkDim ( int  index)

Return the requested chunk dimension size.

Parameters
[in]indexof dimension
Returns
size of the dimension

◆ getDim()

hsize_t NDFileHDF5::getDim ( int  index)

Return the requested dimension size.

Parameters
[in]indexof dimension
Returns
size of the dimension

◆ getMaxDim()

hsize_t NDFileHDF5::getMaxDim ( int  index)

Return the requested max dimension size.

Parameters
[in]indexof dimension
Returns
size of the dimension

◆ getOffset()

hsize_t NDFileHDF5::getOffset ( int  index)

Return the requested offset size.

Parameters
[in]indexof offset
Returns
size of the offset

◆ getVirtualDim()

hsize_t NDFileHDF5::getVirtualDim ( int  index)

Return the requested virtual dimension size.

Parameters
[in]indexof dimension
Returns
size of the dimension

◆ openFile()

asynStatus NDFileHDF5::openFile ( const char *  fileName,
NDFileOpenMode_t  openMode,
NDArray pArray 
)
virtual

Opens a HDF5 file.

In write mode if NDFileModeMultiple is set then the first dataspace dimension is set to H5S_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 NDFileHDF5::readFile ( NDArray **  pArray)
virtual

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

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

Implements NDPluginFile.

◆ report()

void NDFileHDF5::report ( FILE *  fp,
int  details 
)
virtual

Report status of the driver.

This method calls the report function in the asynPortDriver base class. It then calls the NDArrayPool::report() method if details >5.

Parameters
[in]fpFile pointed passed by caller where the output is written to.
[in]detailsIf >5 then NDArrayPool::report and NDAttributeList::report are both called.

Reimplemented from asynNDArrayDriver.

◆ setMultiFrameFile()

void NDFileHDF5::setMultiFrameFile ( bool  multi)
protected

Set the multi frame parameter.

Parameters
[in]multiboolean to set the writer frame mode

◆ startSWMR()

asynStatus NDFileHDF5::startSWMR ( )

◆ storeOnCloseAttributes()

asynStatus NDFileHDF5::storeOnCloseAttributes ( )

Check through attributes and store any that have been marked as onClose.

◆ storeOnOpenAttributes()

asynStatus NDFileHDF5::storeOnOpenAttributes ( )

Check through attributes and store any that have been marked as onOpen.

◆ storeOnOpenCloseAttribute()

asynStatus NDFileHDF5::storeOnOpenCloseAttribute ( hdf5::Element element,
bool  open 
)

Check attribute and store if marked as onOpen or onClose when opening or closing.

◆ verifyLayoutXMLFile()

int NDFileHDF5::verifyLayoutXMLFile ( )

Verify the XML layout file is valid.

This method checks the file exists and can be opened. If these checks pass then the file is opened and the XML is also parsed and verified. Any error messages are reported and the status set accordingly. This must be called with the lock already taken.

◆ writeFile()

asynStatus NDFileHDF5::writeFile ( NDArray pArray)
virtual

Writes NDArray data to a HDF5 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 NDFileHDF5::openFile.

Implements NDPluginFile.

◆ writeH5attrFloat64()

void NDFileHDF5::writeH5attrFloat64 ( hid_t  element,
const std::string &  attr_name,
const std::string &  str_attr_value 
) const

Write a float (or array of floats) constant attribute.

◆ writeH5attrInt32()

void NDFileHDF5::writeH5attrInt32 ( hid_t  element,
const std::string &  attr_name,
const std::string &  str_attr_value 
) const

Write an int (or array of ints) constant attribute.

◆ writeH5attrStr()

void NDFileHDF5::writeH5attrStr ( hid_t  element,
const std::string &  attr_name,
const std::string &  str_attr_value 
) const

Write a string constant attribute.

◆ writeH5dsetFloat64()

hid_t NDFileHDF5::writeH5dsetFloat64 ( hid_t  element,
const std::string &  name,
const std::string &  str_value 
) const

◆ writeH5dsetInt32()

hid_t NDFileHDF5::writeH5dsetInt32 ( hid_t  element,
const std::string &  name,
const std::string &  str_value 
) const

◆ writeH5dsetStr()

hid_t NDFileHDF5::writeH5dsetStr ( hid_t  element,
const std::string &  name,
const std::string &  str_value 
) const

Write a string constant dataset.

◆ writeHdfAttributes()

void NDFileHDF5::writeHdfAttributes ( hid_t  h5_handle,
hdf5::Element element 
)

Check this element for any attached attributes and write them out.

Supported types are 'string', 'int' and 'float'.

The types 'int' and 'float' can contain 1D arrays, where each element is separated by a ','

◆ writeHdfConstDataset()

hid_t NDFileHDF5::writeHdfConstDataset ( hid_t  h5_handle,
hdf5::Dataset dset 
)

◆ writeInt32()

asynStatus NDFileHDF5::writeInt32 ( asynUser *  pasynUser,
epicsInt32  value 
)
virtual

Perform any actions required when an int32 parameter is updated.

Reimplemented from NDPluginFile.

◆ writeOctet()

asynStatus NDFileHDF5::writeOctet ( asynUser *  pasynUser,
const char *  value,
size_t  nChars,
size_t *  nActual 
)
virtual

Called when asyn clients call pasynOctet->write().

This function performs actions for some parameters, including AttributesFile. For all parameters it sets the value in the parameter library and calls any registered callbacks..

Parameters
[in]pasynUserpasynUser structure that encodes the reason and address.
[in]valueAddress of the string to write.
[in]nCharsNumber of characters to write.
[out]nActualNumber of characters actually written.

Reimplemented from NDPluginDriver.

Member Data Documentation

◆ attDataMap

std::map<std::string, hid_t> NDFileHDF5::attDataMap

◆ codec

Codec_t NDFileHDF5::codec

◆ defDsetName

std::string NDFileHDF5::defDsetName

◆ detDataMap

std::map<std::string, NDFileHDF5Dataset *> NDFileHDF5::detDataMap

◆ ndDsetName

std::string NDFileHDF5::ndDsetName

◆ NDFileHDF5_bloscCompressLevel

int NDFileHDF5::NDFileHDF5_bloscCompressLevel
protected

◆ NDFileHDF5_bloscCompressor

int NDFileHDF5::NDFileHDF5_bloscCompressor
protected

◆ NDFileHDF5_bloscShuffleType

int NDFileHDF5::NDFileHDF5_bloscShuffleType
protected

◆ NDFileHDF5_chunkBoundaryAlign

int NDFileHDF5::NDFileHDF5_chunkBoundaryAlign
protected

◆ NDFileHDF5_chunkBoundaryThreshold

int NDFileHDF5::NDFileHDF5_chunkBoundaryThreshold
protected

◆ NDFileHDF5_chunkSize

int NDFileHDF5::NDFileHDF5_chunkSize[MAX_CHUNK_DIMS]
protected

◆ NDFileHDF5_chunkSizeAuto

int NDFileHDF5::NDFileHDF5_chunkSizeAuto
protected

◆ NDFileHDF5_compressionType

int NDFileHDF5::NDFileHDF5_compressionType
protected

◆ NDFileHDF5_dimAttDatasets

int NDFileHDF5::NDFileHDF5_dimAttDatasets
protected

◆ NDFileHDF5_extraDimChunk

int NDFileHDF5::NDFileHDF5_extraDimChunk[MAXEXTRADIMS]
protected

◆ NDFileHDF5_extraDimName

int NDFileHDF5::NDFileHDF5_extraDimName[MAXEXTRADIMS]
protected

◆ NDFileHDF5_extraDimOffsetX

int NDFileHDF5::NDFileHDF5_extraDimOffsetX
protected

◆ NDFileHDF5_extraDimOffsetY

int NDFileHDF5::NDFileHDF5_extraDimOffsetY
protected

◆ NDFileHDF5_extraDimSize

int NDFileHDF5::NDFileHDF5_extraDimSize[MAXEXTRADIMS]
protected

◆ NDFileHDF5_fillValue

int NDFileHDF5::NDFileHDF5_fillValue
protected

◆ NDFileHDF5_flushNthFrame

int NDFileHDF5::NDFileHDF5_flushNthFrame
protected

◆ NDFileHDF5_jpegQuality

int NDFileHDF5::NDFileHDF5_jpegQuality
protected

◆ NDFileHDF5_layoutErrorMsg

int NDFileHDF5::NDFileHDF5_layoutErrorMsg
protected

◆ NDFileHDF5_layoutFilename

int NDFileHDF5::NDFileHDF5_layoutFilename
protected

◆ NDFileHDF5_layoutValid

int NDFileHDF5::NDFileHDF5_layoutValid
protected

◆ NDFileHDF5_nbitsOffset

int NDFileHDF5::NDFileHDF5_nbitsOffset
protected

◆ NDFileHDF5_nbitsPrecision

int NDFileHDF5::NDFileHDF5_nbitsPrecision
protected

◆ NDFileHDF5_NDAttributeChunk

int NDFileHDF5::NDFileHDF5_NDAttributeChunk
protected

◆ NDFileHDF5_nExtraDims

int NDFileHDF5::NDFileHDF5_nExtraDims
protected

◆ NDFileHDF5_nFramesChunks

int NDFileHDF5::NDFileHDF5_nFramesChunks
protected

◆ NDFileHDF5_posIndex

int NDFileHDF5::NDFileHDF5_posIndex[MAXEXTRADIMS]
protected

◆ NDFileHDF5_posName

int NDFileHDF5::NDFileHDF5_posName[MAXEXTRADIMS]
protected

◆ NDFileHDF5_posRunning

int NDFileHDF5::NDFileHDF5_posRunning
protected

◆ NDFileHDF5_storeAttributes

int NDFileHDF5::NDFileHDF5_storeAttributes
protected

◆ NDFileHDF5_storePerformance

int NDFileHDF5::NDFileHDF5_storePerformance
protected

◆ NDFileHDF5_SWMRCbCounter

int NDFileHDF5::NDFileHDF5_SWMRCbCounter
protected

◆ NDFileHDF5_SWMRFlushNow

int NDFileHDF5::NDFileHDF5_SWMRFlushNow
protected

◆ NDFileHDF5_SWMRMode

int NDFileHDF5::NDFileHDF5_SWMRMode
protected

◆ NDFileHDF5_SWMRRunning

int NDFileHDF5::NDFileHDF5_SWMRRunning
protected

◆ NDFileHDF5_SWMRSupported

int NDFileHDF5::NDFileHDF5_SWMRSupported
protected

◆ NDFileHDF5_szipNumPixels

int NDFileHDF5::NDFileHDF5_szipNumPixels
protected

◆ NDFileHDF5_totalIoSpeed

int NDFileHDF5::NDFileHDF5_totalIoSpeed
protected

◆ NDFileHDF5_totalRuntime

int NDFileHDF5::NDFileHDF5_totalRuntime
protected

◆ NDFileHDF5_zCompressLevel

int NDFileHDF5::NDFileHDF5_zCompressLevel
protected

◆ onCloseMap

std::map<std::string, hdf5::Element *> NDFileHDF5::onCloseMap

◆ onOpenMap

std::map<std::string, hdf5::Element *> NDFileHDF5::onOpenMap

◆ str_NDFileHDF5_chunkSize

const char * NDFileHDF5::str_NDFileHDF5_chunkSize
static
Initial value:
= {
"HDF5_nColChunks",
"HDF5_nRowChunks",
"HDF5_chunkSize2",
"HDF5_chunkSize3",
"HDF5_chunkSize4",
"HDF5_chunkSize5",
"HDF5_chunkSize6",
"HDF5_chunkSize7",
"HDF5_chunkSize8",
"HDF5_chunkSize9"
}

◆ str_NDFileHDF5_extraDimChunk

const char * NDFileHDF5::str_NDFileHDF5_extraDimChunk
static
Initial value:
= {
"HDF5_extraDimChunkN",
"HDF5_extraDimChunkX",
"HDF5_extraDimChunkY",
"HDF5_extraDimChunk3",
"HDF5_extraDimChunk4",
"HDF5_extraDimChunk5",
"HDF5_extraDimChunk6",
"HDF5_extraDimChunk7",
"HDF5_extraDimChunk8",
"HDF5_extraDimChunk9"
}

◆ str_NDFileHDF5_extraDimName

const char * NDFileHDF5::str_NDFileHDF5_extraDimName
static
Initial value:
= {
"HDF5_extraDimNameN",
"HDF5_extraDimNameX",
"HDF5_extraDimNameY",
"HDF5_extraDimName3",
"HDF5_extraDimName4",
"HDF5_extraDimName5",
"HDF5_extraDimName6",
"HDF5_extraDimName7",
"HDF5_extraDimName8",
"HDF5_extraDimName9"
}

◆ str_NDFileHDF5_extraDimSize

const char * NDFileHDF5::str_NDFileHDF5_extraDimSize
static
Initial value:
= {
"HDF5_extraDimSizeN",
"HDF5_extraDimSizeX",
"HDF5_extraDimSizeY",
"HDF5_extraDimSize3",
"HDF5_extraDimSize4",
"HDF5_extraDimSize5",
"HDF5_extraDimSize6",
"HDF5_extraDimSize7",
"HDF5_extraDimSize8",
"HDF5_extraDimSize9"
}

◆ str_NDFileHDF5_posIndex

const char * NDFileHDF5::str_NDFileHDF5_posIndex
static
Initial value:
= {
"HDF5_posIndexDimN",
"HDF5_posIndexDimX",
"HDF5_posIndexDimY",
"HDF5_posIndexDim3",
"HDF5_posIndexDim4",
"HDF5_posIndexDim5",
"HDF5_posIndexDim6",
"HDF5_posIndexDim7",
"HDF5_posIndexDim8",
"HDF5_posIndexDim9"
}

◆ str_NDFileHDF5_posName

const char * NDFileHDF5::str_NDFileHDF5_posName
static
Initial value:
= {
"HDF5_posNameDimN",
"HDF5_posNameDimX",
"HDF5_posNameDimY",
"HDF5_posNameDim3",
"HDF5_posNameDim4",
"HDF5_posNameDim5",
"HDF5_posNameDim6",
"HDF5_posNameDim7",
"HDF5_posNameDim8",
"HDF5_posNameDim9"
}

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