mtsEventReceiverVoid Class Reference

#include <mtsEventReceiver.h>

Inheritance diagram for mtsEventReceiverVoid:

Public Member Functions
	mtsEventReceiverVoid ()
	~mtsEventReceiverVoid ()
mtsCommandVoid *	GetCommand (void)
void	SetHandlerCommand (mtsCommandVoid *commandHandler)
template<class __classType>
mtsCommandVoid *	SetHandler (void(__classType::*method)(void), __classType *classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
mtsCommandVoid *	SetHandler (void(*function)(void), mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
bool	RemoveHandler (void)
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsEventReceiverBase
	mtsEventReceiverBase ()
virtual	~mtsEventReceiverBase ()
void	SetName (const std::string &name)
virtual std::string	GetName () const
virtual void	SetRequired (const std::string &name, mtsInterfaceRequired *req)
virtual void	SetThreadSignal (osaThreadSignal *signal)
virtual bool	PrepareToWait ()
virtual bool	Wait ()
virtual bool	WaitWithTimeout (double timeoutInSec)
virtual void	ClearWait ()
virtual void	Detach ()

Protected Member Functions
void	EventHandler (void)
Protected Member Functions inherited from mtsEventReceiverBase
bool	CheckRequired () const
void	CheckEventSignal ()
bool	WaitCommon ()

Protected Attributes
mtsCommandVoid *	Command
mtsCommandVoid *	UserHandler
Protected Attributes inherited from mtsEventReceiverBase
std::string	Name
mtsInterfaceRequired *	Required
osaThreadSignal *	EventSignal
bool	OwnEventSignal
WaitStates	WaitState
osaMutex	WaitMutex

Additional Inherited Members
Protected Types inherited from mtsEventReceiverBase
enum	WaitStates { EVENT_RECEIVER_IDLE , EVENT_RECEIVER_PREPARING , EVENT_RECEIVER_WAITING , EVENT_RECEIVER_SIGNALED }

Constructor & Destructor Documentation

mtsEventReceiverVoid()

mtsEventReceiverVoid::mtsEventReceiverVoid

(

)

~mtsEventReceiverVoid()

mtsEventReceiverVoid::~mtsEventReceiverVoid

(

)

Member Function Documentation

EventHandler()

void mtsEventReceiverVoid::EventHandler ( void )

protected

GetCommand()

mtsCommandVoid * mtsEventReceiverVoid::GetCommand

(

void

)

Called from mtsInterfaceRequired::BindCommandsAndEvents

RemoveHandler()

bool mtsEventReceiverVoid::RemoveHandler

(

void

)

SetHandler() [1/2]

mtsCommandVoid * mtsEventReceiverVoid::SetHandler ( void(* function )(void), mtsEventQueueingPolicy queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

SetHandler() [2/2]

template<class __classType>

mtsCommandVoid * mtsEventReceiverVoid::SetHandler ( void(__classType::* method )(void), __classType * classInstantiation, mtsEventQueueingPolicy queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

SetHandlerCommand()

void mtsEventReceiverVoid::SetHandlerCommand

(

mtsCommandVoid *

commandHandler

)

Called from mtsInterfaceRequired::AddEventHandlerVoid

ToStream()

void mtsEventReceiverVoid::ToStream ( std::ostream & outputStream ) const

virtual

Human readable output to stream.

Implements mtsEventReceiverBase.

Member Data Documentation

Command

mtsCommandVoid* mtsEventReceiverVoid::Command

protected

UserHandler

mtsCommandVoid* mtsEventReceiverVoid::UserHandler

protected

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsEventReceiver.h