cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mtsEventReceiverWrite Class Reference

#include <mtsEventReceiver.h>

Inheritance diagram for mtsEventReceiverWrite:
mtsEventReceiverBase

Public Member Functions

 mtsEventReceiverWrite ()
 
 ~mtsEventReceiverWrite ()
 
mtsCommandWriteBaseGetCommand ()
 
void SetHandlerCommand (mtsCommandWriteBase *commandHandler)
 
template<class __classType , class __argumentType >
mtsCommandWriteBaseSetHandler (void(__classType::*method)(const __argumentType &), __classType *classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
 
virtual bool Wait (mtsGenericObject &obj)
 
virtual bool WaitWithTimeout (double timeoutInSec, mtsGenericObject &obj)
 
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 Wait ()
 
virtual bool WaitWithTimeout (double timeoutInSec)
 
virtual void Detach ()
 

Protected Member Functions

void EventHandler (const mtsGenericObject &arg)
 
- Protected Member Functions inherited from mtsEventReceiverBase
bool CheckRequired () const
 
bool WaitCommon ()
 

Protected Attributes

mtsCommandWriteBaseCommand
 
mtsCommandWriteBaseUserHandler
 
mtsGenericObjectArgPtr
 
- Protected Attributes inherited from mtsEventReceiverBase
std::string Name
 
mtsInterfaceRequiredRequired
 
osaThreadSignalEventSignal
 
bool Waiting
 
bool OwnEventSignal
 

Constructor & Destructor Documentation

mtsEventReceiverWrite::mtsEventReceiverWrite ( )
mtsEventReceiverWrite::~mtsEventReceiverWrite ( )

Member Function Documentation

void mtsEventReceiverWrite::EventHandler ( const mtsGenericObject arg)
protected
mtsCommandWriteBase* mtsEventReceiverWrite::GetCommand ( )

Called from mtsInterfaceRequired::BindCommandsAndEvents

bool mtsEventReceiverWrite::RemoveHandler ( void  )
template<class __classType , class __argumentType >
mtsCommandWriteBase* mtsEventReceiverWrite::SetHandler ( void(__classType::*)(const __argumentType &)  method,
__classType *  classInstantiation,
mtsEventQueueingPolicy  queueingPolicy = MTS_INTERFACE_EVENT_POLICY 
)
inline
void mtsEventReceiverWrite::SetHandlerCommand ( mtsCommandWriteBase commandHandler)
void mtsEventReceiverWrite::ToStream ( std::ostream &  outputStream) const
virtual

Human readable output to stream.

Implements mtsEventReceiverBase.

virtual bool mtsEventReceiverWrite::Wait ( mtsGenericObject obj)
virtual

Wait for event to be issued and return received argument.

Returns
true if successful, false if failed (including case where wait succeeded but return value obj is invalid)
virtual bool mtsEventReceiverWrite::WaitWithTimeout ( double  timeoutInSec,
mtsGenericObject obj 
)
virtual

Member Data Documentation

mtsGenericObject* mtsEventReceiverWrite::ArgPtr
protected
mtsCommandWriteBase* mtsEventReceiverWrite::Command
protected
mtsCommandWriteBase* mtsEventReceiverWrite::UserHandler
protected

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