BeaconIdTypes.h

Go to the documentation of this file.

// Copyright 2016 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_BeaconIdTypes_h_GUID_8C85DE41_5CAC_4DA2_6C2A_962680202E1B
#define INCLUDED_BeaconIdTypes_h_GUID_8C85DE41_5CAC_4DA2_6C2A_962680202E1B

// Internal Includes
#include "BodyIdTypes.h"

// Library/third-party includes
#include <osvr/Util/TypeSafeId.h>
#include <boost/assert.hpp>

// Standard includes
#include <stdexcept>

namespace osvr {
namespace vbtracker {
    namespace detail {
        struct ZeroBasedBeaconIdTag;
        struct OneBasedBeaconIdTag;

    } // namespace detail

    using UnderlyingBeaconIdType = int;
} // namespace vbtracker
} // namespace osvr

namespace osvr {
namespace util {
    namespace typesafeid_traits {
        template <>
        struct WrappedType<vbtracker::detail::ZeroBasedBeaconIdTag> {
            using type = vbtracker::UnderlyingBeaconIdType;
        };
        template <> struct WrappedType<vbtracker::detail::OneBasedBeaconIdTag> {
            using type = vbtracker::UnderlyingBeaconIdType;
        };
    } // namespace typesafeid_traits

} // namespace util
} // namespace osvr

namespace osvr {
namespace vbtracker {
    using ZeroBasedBeaconId = util::TypeSafeId<detail::ZeroBasedBeaconIdTag>;
    using OneBasedBeaconId = util::TypeSafeId<detail::OneBasedBeaconIdTag>;

    inline OneBasedBeaconId makeOneBased(ZeroBasedBeaconId id) {
        OneBasedBeaconId ret;
        if (id.empty()) {
            return ret;
        } else if (id.value() < 0) {
            ret = OneBasedBeaconId(id.value());
        } else {
            ret = OneBasedBeaconId(id.value() + 1);
        }
        return ret;
    }

    inline OneBasedBeaconId const &makeOneBased(OneBasedBeaconId const &id) {
        return id;
    }

    inline ZeroBasedBeaconId makeZeroBased(OneBasedBeaconId id) {
        ZeroBasedBeaconId ret;
        if (id.empty()) {
            return ret;
        } else if (id.value() < 0) {
            ret = ZeroBasedBeaconId(id.value());
        } else {
            ret = ZeroBasedBeaconId(id.value() - 1);
        }
        return ret;
    }

    inline ZeroBasedBeaconId const &makeZeroBased(ZeroBasedBeaconId const &id) {
        return id;
    }

    inline bool beaconIdentified(ZeroBasedBeaconId id) {
        return (!id.empty() && id.value() >= 0);
    }
    inline bool beaconIdentified(OneBasedBeaconId id) {
        return (!id.empty() && id.value() > 0);
    }

    inline std::size_t asIndex(ZeroBasedBeaconId id) {
        BOOST_ASSERT_MSG(beaconIdentified(id), "A beacon id must correspond to "
                                               "an identified beacon to be "
                                               "used as an index!");
        if (!beaconIdentified(id)) {
            throw std::logic_error("A beacon id must correspond to an "
                                   "identified beacon to be used as an index!");
        }
        return id.value();
    }

    inline std::size_t asIndex(OneBasedBeaconId id) {
        return asIndex(makeZeroBased(id));
    }

} // namespace vbtracker
} // namespace osvr
#endif // INCLUDED_BeaconIdTypes_h_GUID_8C85DE41_5CAC_4DA2_6C2A_962680202E1B