BaseDevice component, to be used only with the "OSVR" special device. More...

Inheritance diagram for osvr::common::SystemComponent:

Public Types
typedef std::function< void(Json::Value const &, util::time::TimeValue const &)>	JsonHandler

Public Types inherited from osvr::common::DeviceComponent
typedef BaseDevice	Parent

Public Member Functions
OSVR_COMMON_EXPORT void	sendRoutes (std::string const &routes)

OSVR_COMMON_EXPORT void	registerRoutesHandler (vrpn_MESSAGEHANDLER handler, void *userdata)

OSVR_COMMON_EXPORT void	sendClientRouteUpdate (std::string const &route)

OSVR_COMMON_EXPORT void	registerClientRouteUpdateHandler (vrpn_MESSAGEHANDLER handler, void *userdata)

OSVR_COMMON_EXPORT void	registerReplaceTreeHandler (JsonHandler cb)

OSVR_COMMON_EXPORT void	sendReplacementTree (PathTree &tree)

Public Member Functions inherited from osvr::common::DeviceComponent
void	recordParent (Parent &dev)
	Called (only) by BaseDevice when being added: effectively records a "parent pointer" that does not convey ownership. More...

void	update ()
	Called during mainloop.

Static Public Member Functions
static OSVR_COMMON_EXPORT const char *	deviceName ()
	Get the special device name to be used with this component.

static OSVR_COMMON_EXPORT shared_ptr< SystemComponent >	create ()
	Factory method. More...

Public Attributes
messages::RoutesFromServer	routesOut
	Message from server to client, replacing all routes.

messages::AppStartupToServer	appStartup
	Message from client to server, notifying of app ID.

messages::ClientRouteToServer	routeIn
	Message from client, sending a single new/updated JSON routing directive in to the server. More...

messages::ReplacementTreeFromServer	treeOut
	Message from server, updating/replacing the client's configuration.

Additional Inherited Members
Protected Member Functions inherited from osvr::common::DeviceComponent
	DeviceComponent ()
	Protected constructor, to require subclassing.

bool	m_hasParent () const
	Returns true if we have a parent registered.

Parent &	m_getParent ()
	Gets the parent - only call if m_hasParent() is true.

void	m_registerHandler (vrpn_MESSAGEHANDLER handler, void *userdata, RawMessageType const &msgType)
	Registers a handler whose lifetime is tied to the lifetime of the component. More...

virtual void	m_update ()
	Implementation-specific (optional) stuff to do during mainloop.

Detailed Description

BaseDevice component, to be used only with the "OSVR" special device.

Member Function Documentation

shared_ptr< SystemComponent > osvr::common::SystemComponent::create ( )

static

Factory method.

Required to ensure that allocation and deallocation stay on the same side of a DLL line.

messages::ClientRouteToServer osvr::common::SystemComponent::routeIn

Message from client, sending a single new/updated JSON routing directive in to the server.

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