JointClientKitC.cpp File Reference

Implementation. More...

#include <osvr/JointClientKit/JointClientKitC.h>
#include "JointClientContext.h"
#include <osvr/Server/Server.h>
#include <osvr/Util/MacroToolsC.h>
#include <osvr/Util/Verbosity.h>
#include <functional>
#include <vector>
#include <memory>
#include <string>

Classes
struct	OSVR_JointClientContextOptsObject

Macros
#define	OSVR_CHECK_OPTS
#define	OSVR_OPTS_SINGLE_SHOT(MEMBER, DESC)
#define	OSVR_OPTS_CHECK_STRING(PARAM, DESC)

Typedefs
using	ServerOp = std::function< void(Server &)>

Functions
OSVR_JointClientOpts	osvrJointClientCreateOptions ()
	Creates an empty OSVR_JointClientOpts. More...
OSVR_ReturnCode	osvrJointClientOptionsAutoloadPlugins (OSVR_JointClientOpts opts)
	Queues up the autoloading of plugins. More...
OSVR_ReturnCode	osvrJointClientOptionsLoadPlugin (OSVR_JointClientOpts opts, const char *pluginName)
	Queues up the manual load of a plugin by name.
OSVR_ReturnCode	osvrJointClientOptionsInstantiateDriver (OSVR_JointClientOpts opts, const char *pluginName, const char *driverName, const char *params)
	Queues up the manual instantiation of a plugin/driver by name with optional parameters (JSON).
OSVR_ReturnCode	osvrJointClientOptionsAddAlias (OSVR_JointClientOpts opts, const char *path, const char *source)
	Queues up the manual addition of an alias to the path tree.
OSVR_ReturnCode	osvrJointClientOptionsAddAliases (OSVR_JointClientOpts opts, const char *aliases)
	Queues up the manual addition of aliases specified in JSON to the path tree.
OSVR_ReturnCode	osvrJointClientOptionsAddString (OSVR_JointClientOpts opts, const char *path, const char *s)
	Queues up the manual addition of a string element to the path tree.
OSVR_ReturnCode	osvrJointClientOptionsTriggerHardwareDetect (OSVR_JointClientOpts opts)
	Queues up a trigger for hardware detection.
OSVR_ClientContext	osvrJointClientInit (const char applicationIdentifier[], OSVR_JointClientOpts opts)
	Initialize the library, starting up a "joint" context that also contains a server. More...

Detailed Description

Implementation.

Date

2015

Author

Sensics, Inc. http://sensics.com/osvr

Macro Definition Documentation

OSVR_CHECK_OPTS

#define OSVR_CHECK_OPTS

Value:

OSVR_UTIL_MULTILINE_BEGIN                                                  \
    if (nullptr == opts) {                                                     \
        OSVR_DEV_VERBOSE(                                                      \
            "Can't modify a null JointClientKit options object!");             \
        return OSVR_RETURN_FAILURE;                                            \
    }                                                                          \
    OSVR_UTIL_MULTILINE_END

OSVR_OPTS_CHECK_STRING

#define OSVR_OPTS_CHECK_STRING	(		PARAM,
			DESC
	)

Value:

OSVR_UTIL_MULTILINE_BEGIN                                                  \
    if (nullptr == (PARAM) || '\0' == (PARAM)[0]) {                            \
        OSVR_DEV_VERBOSE("Invalid string passed for  " DESC                    \
                         " -- can't be null or empty!");                       \
        return OSVR_RETURN_FAILURE;                                            \
    }                                                                          \
    OSVR_UTIL_MULTILINE_END

OSVR_OPTS_SINGLE_SHOT

#define OSVR_OPTS_SINGLE_SHOT	(		MEMBER,
			DESC
	)

Value:

OSVR_UTIL_MULTILINE_BEGIN                                                  \
    if (opts->MEMBER) {                                                        \
        OSVR_DEV_VERBOSE("Already queued " DESC                                \
                         " -- can't do it a second time!");                    \
        return OSVR_RETURN_FAILURE;                                            \
    }                                                                          \
    opts->MEMBER = true;                                                       \
    OSVR_UTIL_MULTILINE_END