OSVR-Core
ProcessDeviceDescriptor.h
Go to the documentation of this file.
1 
11 // Copyright 2015 Sensics, Inc.
12 //
13 // Licensed under the Apache License, Version 2.0 (the "License");
14 // you may not use this file except in compliance with the License.
15 // You may obtain a copy of the License at
16 //
17 // http://www.apache.org/licenses/LICENSE-2.0
18 //
19 // Unless required by applicable law or agreed to in writing, software
20 // distributed under the License is distributed on an "AS IS" BASIS,
21 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 // See the License for the specific language governing permissions and
23 // limitations under the License.
24 
25 #ifndef INCLUDED_ProcessDeviceDescriptor_h_GUID_BB1EC60E_95C8_4C96_3FF3_F16B1C83A5A1
26 #define INCLUDED_ProcessDeviceDescriptor_h_GUID_BB1EC60E_95C8_4C96_3FF3_F16B1C83A5A1
27 
28 // Internal Includes
29 #include <osvr/Common/Export.h>
33 
34 // Library/third-party includes
35 // - none
36 
37 // Standard includes
38 #include <string>
39 
40 namespace osvr {
41 namespace common {
45  OSVR_COMMON_EXPORT bool
47  std::string const &deviceName,
48  std::string const &jsonDescriptor,
49  int listenPort, std::string const &host);
50 
55  OSVR_COMMON_EXPORT bool processDeviceDescriptorFromExistingDevice(
56  PathNode &devNode, elements::DeviceElement const &devElt);
57 
58 } // namespace common
59 } // namespace osvr
60 
61 #endif // INCLUDED_ProcessDeviceDescriptor_h_GUID_BB1EC60E_95C8_4C96_3FF3_F16B1C83A5A1
Handles spatial transformations.
Definition: SerializationTraitExample_Complicated.h:40
::osvr::util::TreeNode< PathElement > PathNode
The specific tree node type that contains a path element.
Definition: PathNode_fwd.h:42
The main namespace for all C++ elements of the framework, internal and external.
Definition: namespace_osvr.dox:3
The element type corresponding to a device, which implements 0 or more interfaces.
Definition: PathElementTypes.h:113
OSVR_COMMON_EXPORT bool processDeviceDescriptorForPathTree(PathTree &tree, std::string const &deviceName, std::string const &jsonDescriptor, int listenPort, std::string const &host)
Set up a path tree based on a device descriptor.
Definition: ProcessDeviceDescriptor.cpp:172
Header forward-declaring the types in PathElementTypes.h and including the PathElement typedef...
OSVR_COMMON_EXPORT bool processDeviceDescriptorFromExistingDevice(PathNode &devNode, elements::DeviceElement const &devElt)
Set up a path tree based on a device descriptor from an existing DeviceElement node.
Definition: ProcessDeviceDescriptor.cpp:223