areaDetector 1-9
Public Member Functions | Protected Attributes
NDFileMagick Class Reference

#include <NDFileMagick.h>

Inheritance diagram for NDFileMagick:
NDPluginFile NDPluginDriver asynNDArrayDriver asynPortDriver

List of all members.

Public Member Functions

 NDFileMagick (const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int priority, int stackSize)
 Constructor for NDFileMagick; all parameters are simply passed to NDPluginFile::NDPluginFile.
virtual asynStatus openFile (const char *fileName, NDFileOpenMode_t openMode, NDArray *pArray)
 Opens a Magick file.
virtual asynStatus readFile (NDArray **pArray)
 Reads single NDArray from a file; NOT CURRENTLY IMPLEMENTED.
virtual asynStatus writeFile (NDArray *pArray)
 Writes single NDArray to the Magick file.
virtual asynStatus closeFile ()
 Closes the file.

Protected Attributes

int NDFileMagickQuality
int NDFileMagickCompressType
int NDFileMagickBitDepth

Constructor & Destructor Documentation

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

Constructor for NDFileMagick; all parameters are simply passed to NDPluginFile::NDPluginFile.

Parameters:
[in]portNameThe name of the asyn port driver to be created.
[in]queueSizeThe number of NDArrays that the input queue for this plugin can hold when NDPluginDriverBlockingCallbacks=0. Larger queues can decrease the number of dropped arrays, at the expense of more NDArray buffers being allocated from the underlying driver's NDArrayPool.
[in]blockingCallbacksInitial setting for the NDPluginDriverBlockingCallbacks flag. 0=callbacks are queued and executed by the callback thread; 1 callbacks execute in the thread of the driver doing the callbacks.
[in]NDArrayPortName of asyn port driver for initial source of NDArray callbacks.
[in]NDArrayAddrasyn port driver address for initial source of NDArray callbacks.
[in]priorityThe thread priority for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.
[in]stackSizeThe stack size for the asyn port driver thread if ASYN_CANBLOCK is set in asynFlags.

Member Function Documentation

asynStatus NDFileMagick::closeFile ( ) [virtual]

Closes the file.

Implements NDPluginFile.

asynStatus NDFileMagick::openFile ( const char *  fileName,
NDFileOpenMode_t  openMode,
NDArray pArray 
) [virtual]

Opens a Magick file.

Parameters:
[in]fileNameThe name of the file to open.
[in]openModeMask defining how the file should be opened; bits are NDFileModeRead, NDFileModeWrite, NDFileModeAppend, NDFileModeMultiple
[in]pArrayA pointer to an NDArray; this is used to determine the array and attribute properties.

Implements NDPluginFile.

asynStatus NDFileMagick::readFile ( NDArray **  pArray) [virtual]

Reads single NDArray from a file; NOT CURRENTLY IMPLEMENTED.

Parameters:
[in]pArrayPointer to the NDArray to be read

Implements NDPluginFile.

asynStatus NDFileMagick::writeFile ( NDArray pArray) [virtual]

Writes single NDArray to the Magick file.

Parameters:
[in]pArrayPointer to the NDArray to be written

Implements NDPluginFile.


Member Data Documentation


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