OSVR-Core
Public Member Functions | Static Public Member Functions | List of all members
osvr::common::elements::DeviceElement Class Reference

The element type corresponding to a device, which implements 0 or more interfaces. More...

#include <PathElementTypes.h>

Inheritance diagram for osvr::common::elements::DeviceElement:
osvr::common::elements::ElementBase< DeviceElement >

Public Member Functions

 DeviceElement (std::string const &deviceName, std::string const &server)
 
OSVR_COMMON_EXPORT std::string & getDeviceName ()
 
OSVR_COMMON_EXPORT std::string const & getDeviceName () const
 
OSVR_COMMON_EXPORT std::string & getServer ()
 
OSVR_COMMON_EXPORT std::string const & getServer () const
 
OSVR_COMMON_EXPORT std::string getFullDeviceName () const
 
OSVR_COMMON_EXPORT Json::Value & getDescriptor ()
 
OSVR_COMMON_EXPORT Json::Value const & getDescriptor () const
 
bool operator== (DeviceElement const &other) const
 Equality comparison operator.
 
- Public Member Functions inherited from osvr::common::elements::ElementBase< DeviceElement >
const char * getTypeName () const
 

Static Public Member Functions

static OSVR_COMMON_EXPORT DeviceElement createVRPNDeviceElement (std::string const &deviceName, std::string const &server)
 
static OSVR_COMMON_EXPORT DeviceElement createDeviceElement (std::string const &deviceName, std::string const &server, int port=util::UseDefaultPort)
 Can also pass util::OmitAppendingPort as a special port value. More...
 

Additional Inherited Members

- Public Types inherited from osvr::common::elements::ElementBase< DeviceElement >
typedef DeviceElement type
 
typedef ElementBase< DeviceElementbase_type
 
- Protected Member Functions inherited from osvr::common::elements::ElementBase< DeviceElement >
 ElementBase ()
 Protected constructor to force subclassing. More...
 

Detailed Description

The element type corresponding to a device, which implements 0 or more interfaces.

Member Function Documentation

§ createDeviceElement()

DeviceElement osvr::common::elements::DeviceElement::createDeviceElement ( std::string const &  deviceName,
std::string const &  server,
int  port = util::UseDefaultPort 
)
static

Can also pass util::OmitAppendingPort as a special port value.


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