vrpn_MainloopObject Class Reference

An interface for all VRPN objects that have a "mainloop" method. Not instantiated directly: use vrpn_MainloopObject::wrap() to create one. More...

#include <vrpn_MainloopObject.h>

Inheritance diagram for vrpn_MainloopObject:

Classes
struct	CannotWrapNullPointerIntoMainloopObject
	Exception thrown when trying to wrap a NULL pointer. More...

Public Member Functions
virtual	~vrpn_MainloopObject ()
	Destructor.
virtual void	mainloop ()=0
	The mainloop function: the primary thing we look for in a VRPN object.
virtual bool	broken ()=0
	Checks the connectionPtr() for the VRPN object to make sure it is not NULL.

Static Public Member Functions
template<class T >
static vrpn_MainloopObject *	wrap (T o)
	Templated wrapping function.
template<class T >
static vrpn_MainloopObject *	wrap (T o, bool owner)
	Templated wrapping function that can encourage the wrapper to not destroy the wrapped object at destruction.

Protected Member Functions
virtual void *	_returnContained () const =0
	Internal function to return a typeless pointer of the contained object, for comparison purposes.
	vrpn_MainloopObject ()

Comparison operators
bool	operator== (vrpn_MainloopObject const &lhs, vrpn_MainloopObject const &rhs)
bool	operator!= (vrpn_MainloopObject const &lhs, vrpn_MainloopObject const &rhs)
bool	operator== (vrpn_MainloopObject const &lhs, vrpn_MainloopObject const &rhs)
bool	operator!= (vrpn_MainloopObject const &lhs, vrpn_MainloopObject const &rhs)

Detailed Description

An interface for all VRPN objects that have a "mainloop" method. Not instantiated directly: use vrpn_MainloopObject::wrap() to create one.

Definition at line 43 of file vrpn_MainloopObject.h.

Constructor & Destructor Documentation

~vrpn_MainloopObject()

virtual vrpn_MainloopObject::~vrpn_MainloopObject ( )

inlinevirtual

Destructor.

Definition at line 55 of file vrpn_MainloopObject.h.

vrpn_MainloopObject()

vrpn_MainloopObject::vrpn_MainloopObject ( )

inlineprotected

Definition at line 75 of file vrpn_MainloopObject.h.

Member Function Documentation

_returnContained()

virtual void * vrpn_MainloopObject::_returnContained ( ) const

protectedpure virtual

Internal function to return a typeless pointer of the contained object, for comparison purposes.

Implemented in detail::TypedMainloopObject< T * >, and detail::TypedMainloopObject< vrpn_Connection * >.

broken()

virtual bool vrpn_MainloopObject::broken ( )

pure virtual

Checks the connectionPtr() for the VRPN object to make sure it is not NULL.

Implemented in detail::TypedMainloopObject< T * >, and detail::TypedMainloopObject< vrpn_Connection * >.

Referenced by vrpn_MainloopContainer::add().

mainloop()

virtual void vrpn_MainloopObject::mainloop ( )

pure virtual

The mainloop function: the primary thing we look for in a VRPN object.

Implemented in detail::TypedMainloopObject< T * >, and detail::TypedMainloopObject< vrpn_Connection * >.

wrap() [1/2]

template<class T >

vrpn_MainloopObject * vrpn_MainloopObject::wrap ( T  o )

inlinestatic

Templated wrapping function.

Definition at line 176 of file vrpn_MainloopObject.h.

Referenced by vrpn_MainloopContainer::add().

wrap() [2/2]

template<class T >

vrpn_MainloopObject * vrpn_MainloopObject::wrap ( T  o, bool  owner  )

inlinestatic

Templated wrapping function that can encourage the wrapper to not destroy the wrapped object at destruction.

Definition at line 186 of file vrpn_MainloopObject.h.

Friends And Related Symbol Documentation

operator!= [1/2]

bool operator!= ( vrpn_MainloopObject const &  lhs, vrpn_MainloopObject const &  rhs  )

friend

Definition at line 91 of file vrpn_MainloopObject.h.

operator!=() [2/2]

bool operator!= ( vrpn_MainloopObject const &  lhs, vrpn_MainloopObject const &  rhs  )

related

Definition at line 91 of file vrpn_MainloopObject.h.

operator== [1/2]

bool operator== ( vrpn_MainloopObject const &  lhs, vrpn_MainloopObject const &  rhs  )

friend

Definition at line 85 of file vrpn_MainloopObject.h.

operator==() [2/2]

bool operator== ( vrpn_MainloopObject const &  lhs, vrpn_MainloopObject const &  rhs  )

related

Definition at line 85 of file vrpn_MainloopObject.h.

---

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

• vrpn_MainloopObject.h