OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
OSVR_DeviceInitObject Struct Reference

Structure used internally to construct the desired type of device. More...

#include <osvr/Connection/DeviceInitObject.h>

Inheritance diagram for OSVR_DeviceInitObject:

Public Member Functions

 OSVR_DeviceInitObject (OSVR_PluginRegContext ctx)
 
 OSVR_DeviceInitObject (osvr::connection::ConnectionPtr conn)
 
void setName (std::string const &n)
 Set the (unqualified) name of the device to create.
 
void setAnalogs (OSVR_ChannelCount num, osvr::connection::AnalogServerInterface **iface)
 Set analogs: clears the boost::optional if 0 is passed.
 
void returnAnalogInterface (osvr::connection::AnalogServerInterface &iface)
 Returns an analog interface through the pointer-pointer.
 
void setButtons (OSVR_ChannelCount num, osvr::connection::ButtonServerInterface **iface)
 Set buttons: clears the boost::optional if 0 is passed.
 
void returnButtonInterface (osvr::connection::ButtonServerInterface &iface)
 Returns a button interface through the pointer-pointer.
 
void setTracker (osvr::connection::TrackerServerInterface **iface)
 Enables tracker interface.
 
void addServerInterface (osvr::connection::ServerInterfacePtr const &iface)
 Add a server interface pointer to our list, which will get registered when the device is created.
 
void addComponent (osvr::common::DeviceComponentPtr const &comp)
 Add a device component to our list, which will get added to the device when created.
 
template<typename T >
T * makeInterfaceObject ()
 A helper method to make a "device interface object" of user-designated type and apppropriate lifetime.
 
void addTokenInterest (OSVR_DeviceTokenObject **devPtr)
 Add an observer that we'll eventually inform about the device token.
 
void addTokenInterest (osvr::connection::DeviceInterfaceBase *ifaceObj)
 
void notifyToken (OSVR_DeviceTokenObject *dev)
 Notify all those interested what the device token is.
 
void returnTrackerInterface (osvr::connection::TrackerServerInterface &iface)
 Returns a tracker interface through the pointer-pointer.
 
std::string getQualifiedName () const
 Get device name qualified by plugin name.
 
osvr::connection::ConnectionPtr getConnection ()
 Retrieve the connection pointer.
 
osvr::pluginhost::PluginSpecificRegistrationContextgetContext ()
 Retrieves the plugin context.
 
boost::optional
< OSVR_ChannelCount
getAnalogs () const
 
boost::optional
< OSVR_ChannelCount
getButtons () const
 
bool getTracker () const
 
osvr::connection::ServerInterfaceList
const & 
getServerInterfaces () const
 
osvr::common::DeviceComponentList
const & 
getComponents () const
 

Detailed Description

Structure used internally to construct the desired type of device.

Definition at line 59 of file DeviceInitObject.h.


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