RegisteredStringMap.h

Go to the documentation of this file.

// Copyright 2015 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_RegisteredStringMap_h_GUID_066235BE_3687_44AD_C2A4_593D6E6780F3
#define INCLUDED_RegisteredStringMap_h_GUID_066235BE_3687_44AD_C2A4_593D6E6780F3

// Internal Includes
#include <osvr/Common/Export.h>
#include <osvr/Util/StringIds.h>

// Library/third-party includes
#include <json/value.h>

// Standard includes
#include <vector>

namespace osvr {
namespace common {

    class RegisteredStringMap {
      public:
        OSVR_COMMON_EXPORT util::StringID
        registerStringID(std::string const &str);

        OSVR_COMMON_EXPORT util::StringID
        getStringID(std::string const &str) const;

        OSVR_COMMON_EXPORT std::string getStringFromId(util::StringID id) const;

        OSVR_COMMON_EXPORT bool isModified() const;
        OSVR_COMMON_EXPORT void clearModifiedFlag();

        OSVR_COMMON_EXPORT void printCurrentMap();

        OSVR_COMMON_EXPORT std::vector<std::string> getEntries() const;

      protected:
        std::vector<std::string> m_regEntries;

        bool m_modified = false;
    };

    class CorrelatedStringMap {
      public:
        OSVR_COMMON_EXPORT util::StringID
        registerStringID(std::string const &str);

        OSVR_COMMON_EXPORT util::StringID getStringID(std::string const &str) const;

        OSVR_COMMON_EXPORT std::string getStringFromId(util::StringID id) const;

        OSVR_COMMON_EXPORT util::StringID
        convertPeerToLocalID(util::PeerStringID peerID) const;

        OSVR_COMMON_EXPORT void
        setupPeerMappings(std::vector<std::string> const &peerEntries);

      private:
        RegisteredStringMap m_local;
        std::vector<uint32_t> m_remoteToLocal;
    };
} // namespace common
} // namespace osvr
#endif // INCLUDED_RegisteredStringMap_h_GUID_066235BE_3687_44AD_C2A4_593D6E6780F3