ito::PluginThreadCtrl Class Reference

Inheritance diagram for ito::PluginThreadCtrl:

List of all members.

Public Member Functions
	PluginThreadCtrl ()
	PluginThreadCtrl (const ito::ParamBase &pluginParameter, ito::RetVal *retval=NULL)
	PluginThreadCtrl (ito::AddInBase *plugin, ito::RetVal *retval=NULL)
	PluginThreadCtrl (const PluginThreadCtrl &other)
virtual	~PluginThreadCtrl ()
PluginThreadCtrl &	operator= (const PluginThreadCtrl &other)
ito::RetVal	getParam (ito::Param &val, int timeOutMS=PLUGINWAIT)
ito::RetVal	setParam (ito::ParamBase val, int timeOutMS=PLUGINWAIT)
Protected Member Functions
ito::RetVal	waitForSemaphore (ItomSharedSemaphore *waitCond, int timeOutMS=PLUGINWAIT)
Protected Attributes
ito::AddInBase *	m_pPlugin

---

Constructor & Destructor Documentation

ito::PluginThreadCtrl::PluginThreadCtrl

(

)

< Wait until camera-thread has finished the last command

ito::PluginThreadCtrl::PluginThreadCtrl	(	const ito::ParamBase &	pluginParameter,
		ito::RetVal *	retval = NULL
	)

< Constructor

Returns:

(void)

See also:

CameraThreadCtrl

ito::PluginThreadCtrl::PluginThreadCtrl	(	ito::AddInBase *	plugin,
		ito::RetVal *	retval = NULL
	)

< Constructor

ito::PluginThreadCtrl::PluginThreadCtrl

(

const PluginThreadCtrl &

other

)

< Constructor

ito::PluginThreadCtrl::~PluginThreadCtrl

(

)

[virtual]

The destructor

---

Member Function Documentation

ito::RetVal ito::PluginThreadCtrl::getParam	(	ito::Param &	val,
		int	timeOutMS = PLUGINWAIT
	)

Get any parameter of the camera defined by val.name. val must be initialised and name must be correct. After correct execution, val has the correct value.

Parameters:

	[in|out]	val Initialised tParam (correct name | in)
[in]	timeOutMS	TimeOut for the semaphore-wait

Returns:

retOk or retError

See also:

threadActuator, threadCamera

PluginThreadCtrl & ito::PluginThreadCtrl::operator=

(

const PluginThreadCtrl &

other

)

< Destructor

ito::RetVal ito::PluginThreadCtrl::setParam	(	ito::ParamBase	val,
		int	timeOutMS = PLUGINWAIT
	)

< Get the parameter of the plugin

Get the parameter of the plugin defined by val.name to the value of val.

Parameters:

[in]	val	Initialised tParam (correct name | value)
[in]	timeOutMS	TimeOut for the semaphore-wait

Returns:

retOk or retError

See also:

threadActuator, threadCamera

ito::RetVal ito::PluginThreadCtrl::waitForSemaphore	(	ItomSharedSemaphore *	waitCond,
		int	timeOutMS = PLUGINWAIT
	)		[protected]

< Handle to the plugin

After the invoke-command this thread must wait / be synchronize with the camera-thread. Therefore the wait-Function of pMySemaphore is called. If the camera do not answer within timeOutMS and the pMyCamera is not alive anymore, the function returns a timeout.

Parameters:

[in]

timeOutMS

TimeOut for the semaphore-wait

Returns:

retOk or retError

See also:

threadActuator, threadCamera

---

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

• D:/git-itom/sources/itom/common/pluginThreadCtrl.h
• D:/git-itom/sources/itom/common/sources/pluginThreadCtrl.cpp