itom 2.0.0
ito::DataIOThreadCtrl Class Reference
Inheritance diagram for ito::DataIOThreadCtrl:
ito::PluginThreadCtrl

List of all members.

Public Member Functions

 DataIOThreadCtrl (const ito::ParamBase &pluginParameter, ito::RetVal *retval=NULL)
 DataIOThreadCtrl (ito::AddInDataIO *plugin, ito::RetVal *retval=NULL)
 DataIOThreadCtrl (const DataIOThreadCtrl &other)
ito::RetVal startDevice (int timeOutMS=PLUGINWAIT)
ito::RetVal stopDevice (int timeOutMS=PLUGINWAIT)
ito::RetVal acquire (const int trigger=0, int timeOutMS=PLUGINWAIT)
ito::RetVal getVal (ito::DataObject &dObj, int timeOutMS=PLUGINWAIT)
ito::RetVal copyVal (ito::DataObject &dObj, int timeOutMS=PLUGINWAIT)
ito::RetVal getImageParams (int &bpp, int &sizex, int &sizey, int timeOutMS=PLUGINWAIT)

Constructor & Destructor Documentation

ito::DataIOThreadCtrl::DataIOThreadCtrl ( const ito::ParamBase pluginParameter,
ito::RetVal retval = NULL 
)

< Constructor

ito::DataIOThreadCtrl::DataIOThreadCtrl ( ito::AddInDataIO plugin,
ito::RetVal retval = NULL 
)

< Constructor

ito::DataIOThreadCtrl::DataIOThreadCtrl ( const DataIOThreadCtrl other)

< Constructor


Member Function Documentation

ito::RetVal ito::DataIOThreadCtrl::acquire ( const int  trigger = 0,
int  timeOutMS = PLUGINWAIT 
)

< Set camera deactive

The acquire()-function triggers a new exposure of the camera and returns afterwards. It can only be executed after startDevice(). The function does not wait until the exposure is done. This is performed by the getVal or copyVal-method.

Parameters:
[in]triggerA currently not implemented constant to define trigger-modes during exposure of the camera
[in]timeOutMSTimeOut for the semaphore-wait
Returns:
retOk or retError
See also:
threadActuator, threadCamera, threadCamera::stopDevice, threadCamera::startDevice, threadCamera::getVal, threadCamera::copyVal
ito::RetVal ito::DataIOThreadCtrl::copyVal ( ito::DataObject dObj,
int  timeOutMS = PLUGINWAIT 
)

< Get a shallow-copy of the dataObject

The copyVal function is used to wait until an exposure is finished. Than it gives a deep copy of the inner dataObject within the grabber to the dObj-argument. Before the copyVal()-function can be used an acquire() is neccessary. If the content of dObj do not need to be deepcopied to another object and will not be overwritten after the next acquire() - getVal() combination.

Parameters:
[in|out]dObj IN: an dataObject | OUT: an dataObject containing an shallow copy of the last captured image
[in]timeOutMSTimeOut for the semaphore-wait
Returns:
retOk or retError
See also:
threadActuator, threadCamera, threadCamera::stopDevice, threadCamera::acquire, threadCamera::getVal, threadCamera::startDevice

< Get a deep-copy of the dataObject

ito::RetVal ito::DataIOThreadCtrl::getImageParams ( int &  bpp,
int &  sizex,
int &  sizey,
int  timeOutMS = PLUGINWAIT 
)

< Get a deep-copy of the dataObject

Get the most important parameter of the camera.

Parameters:
[out]bppNumber of Bits this camera grabs
[out]xsizeSize of the camera in x (cols)
[out]ysizeSize of the camera in y (rows)
Returns:
retOk or retError
See also:
threadActuator, threadCamera
ito::RetVal ito::DataIOThreadCtrl::getVal ( ito::DataObject dObj,
int  timeOutMS = PLUGINWAIT 
)

< Trigger an exposure and return before image is done

The getVal function is used to wait until an exposure is finished. Than it gives a shallow copy of the inner dataObject within the grabber to the dObj-argument. Before the getVal()-function can be used an acquire() is neccessary. If the content of dObj is not deepcopied to another object, the data is lost after the next acquire() - getVal() combination and overwritten by the newly captured image.

Parameters:
[in|out]dObj IN: an dataObject | OUT: an dataObject containing an shallow copy of the last captured image
[in]timeOutMSTimeOut for the semaphore-wait
Returns:
retOk or retError
See also:
threadActuator, threadCamera, threadCamera::stopDevice, threadCamera::acquire, threadCamera::startDevice, threadCamera::copyVal

< Get a shallow-copy of the dataObject

ito::RetVal ito::DataIOThreadCtrl::startDevice ( int  timeOutMS = PLUGINWAIT)

< Destructor

Every capture procedure starts with the startDevice() to set the camera active and is ended with stopDevice().

Parameters:
[in]timeOutMSTimeOut for the semaphore-wait
Returns:
retOk or retError
See also:
threadActuator, threadCamera, threadCamera::stopDevice, threadCamera::acquire, threadCamera::getVal, threadCamera::copyVal
ito::RetVal ito::DataIOThreadCtrl::stopDevice ( int  timeOutMS = PLUGINWAIT)

< Set camera active

Every capture procedure starts with the startDevice() to set the camera active and is ended with stopDevice().

Parameters:
[in]timeOutMSTimeOut for the semaphore-wait
Returns:
retOk or retError
See also:
threadActuator, threadCamera, threadCamera::startDevice, threadCamera::acquire, threadCamera::getVal, threadCamera::copyVal

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends