ConnectionDevice.h

Go to the documentation of this file.

// Copyright 2014 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_ConnectionDevice_h_GUID_C04223D7_51D1_49BE_91AB_73FCA9C88515
#define INCLUDED_ConnectionDevice_h_GUID_C04223D7_51D1_49BE_91AB_73FCA9C88515

// Internal Includes
#include <osvr/Connection/Export.h>
#include <osvr/Connection/ConnectionDevicePtr.h>
#include <osvr/Connection/MessageTypePtr.h>
#include <osvr/Connection/DeviceTokenPtr.h>
#include <osvr/Util/TimeValue.h>

// Library/third-party includes
#include <boost/noncopyable.hpp>

// Standard includes
#include <string>
#include <vector>

namespace osvr {
namespace connection {
    class ConnectionDevice : boost::noncopyable {
      public:
        OSVR_CONNECTION_EXPORT virtual ~ConnectionDevice();

        typedef std::vector<std::string> NameList;

        OSVR_CONNECTION_EXPORT std::string const &getName() const;

        NameList const &getNames() const;

        void process();

        void sendData(util::time::TimeValue const &timestamp, MessageType *type,
                      const char *bytestream, size_t len);

        void setDeviceToken(DeviceToken &token);

        OSVR_CONNECTION_EXPORT void
        setDeviceDescriptor(std::string const &jsonString);

        OSVR_CONNECTION_EXPORT std::string const &getDeviceDescriptor() const;

      protected:
        bool m_hasDeviceToken() const;
        DeviceToken &m_getDeviceToken();
        virtual void m_process() = 0;

        virtual void m_sendData(util::time::TimeValue const &timestamp,
                                MessageType *type, const char *bytestream,
                                size_t len) = 0;

        OSVR_CONNECTION_EXPORT ConnectionDevice(std::string const &name);

        OSVR_CONNECTION_EXPORT ConnectionDevice(NameList const &names);

      private:
        NameList m_names;
        DeviceToken *m_token;
        std::string m_descriptor;
    };
} // namespace connection
} // namespace osvr
#endif // INCLUDED_ConnectionDevice_h_GUID_C04223D7_51D1_49BE_91AB_73FCA9C88515