Location.hpp

Go to the documentation of this file.

/*
 * file Location.hpp
 *
 * This file was generated by classgenerator from location.gen.
 * DO NOT CHANGE MANUALLY!
 *
 * Copyright © 2021 Callum McColl. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgement:
 *
 *        This product includes software developed by Callum McColl.
 *
 * 4. Neither the name of the author nor the names of contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * -----------------------------------------------------------------------
 * This program is free software; you can redistribute it and/or
 * modify it under the above terms or under the terms of the GNU
 * General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see http://www.gnu.org/licenses/
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */
 
#ifndef guWhiteboard_Location_h
#define guWhiteboard_Location_h
 
#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
#include <cstdlib>
#include <string.h>
#include <sstream>
#endif
 
#include <gu_util.h>
#include "wb_location.h"
 
#undef guWhiteboard_Location_DEFINED
#define guWhiteboard_Location_DEFINED
 
#undef Location_DEFINED
#define Location_DEFINED
 
#include <guunits/guunits.h>
#include <gucoordinates/gucoordinates.h>
 
#if __cplusplus >= 201703L
#include <optional>
#endif
 
namespace guWhiteboard {
 
    class Location: public wb_location {
 
    private:
 
        void init(int16_t t_direction = 0, uint16_t t_distance = 0, uint8_t t_confidence = 0, uint32_t t_distanceVariance = 0, uint32_t t_directionVariance = 0) {
            set_direction(t_direction);
            set_distance(t_distance);
            set_confidence(t_confidence);
            set_distanceVariance(t_distanceVariance);
            set_directionVariance(t_directionVariance);
        }
 
    public:
 
        Location(int16_t t_direction = 0, uint16_t t_distance = 0, uint8_t t_confidence = 0, uint32_t t_distanceVariance = 0, uint32_t t_directionVariance = 0) {
            this->init(t_direction, t_distance, t_confidence, t_distanceVariance, t_directionVariance);
        }
 
        Location(const Location &t_other): wb_location() {
            this->init(t_other.direction(), t_other.distance(), t_other.confidence(), t_other.distanceVariance(), t_other.directionVariance());
        }
 
        Location(const struct wb_location &t_other): wb_location() {
            this->init(t_other.direction, t_other.distance, t_other.confidence, t_other.distanceVariance, t_other.directionVariance);
        }
 
        Location &operator = (const Location &t_other) {
            this->init(t_other.direction(), t_other.distance(), t_other.confidence(), t_other.distanceVariance(), t_other.directionVariance());
            return *this;
        }
 
        Location &operator = (const struct wb_location &t_other) {
            this->init(t_other.direction, t_other.distance, t_other.confidence, t_other.distanceVariance, t_other.directionVariance);
            return *this;
        }
 
        bool operator ==(const Location &t_other) const
        {
            return direction() == t_other.direction()
                && distance() == t_other.distance()
                && confidence() == t_other.confidence()
                && distanceVariance() == t_other.distanceVariance()
                && directionVariance() == t_other.directionVariance();
        }
 
        bool operator !=(const Location &t_other) const
        {
            return !(*this == t_other);
        }
 
        bool operator ==(const wb_location &t_other) const
        {
            return *this == Location(t_other);
        }
 
        bool operator !=(const wb_location &t_other) const
        {
            return !(*this == t_other);
        }
 
        int16_t & direction()
        {
            return wb_location::direction;
        }
 
        const int16_t & direction() const
        {
            return wb_location::direction;
        }
 
        void set_direction(const int16_t &t_newValue)
        {
            wb_location::direction = t_newValue;
        }
 
        uint16_t & distance()
        {
            return wb_location::distance;
        }
 
        const uint16_t & distance() const
        {
            return wb_location::distance;
        }
 
        void set_distance(const uint16_t &t_newValue)
        {
            wb_location::distance = t_newValue;
        }
 
        uint8_t & confidence()
        {
            return wb_location::confidence;
        }
 
        const uint8_t & confidence() const
        {
            return wb_location::confidence;
        }
 
        void set_confidence(const uint8_t &t_newValue)
        {
            wb_location::confidence = t_newValue;
        }
 
        uint32_t & distanceVariance()
        {
            return wb_location::distanceVariance;
        }
 
        const uint32_t & distanceVariance() const
        {
            return wb_location::distanceVariance;
        }
 
        void set_distanceVariance(const uint32_t &t_newValue)
        {
            wb_location::distanceVariance = t_newValue;
        }
 
        uint32_t & directionVariance()
        {
            return wb_location::directionVariance;
        }
 
        const uint32_t & directionVariance() const
        {
            return wb_location::directionVariance;
        }
 
        void set_directionVariance(const uint32_t &t_newValue)
        {
            wb_location::directionVariance = t_newValue;
        }
 
#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
        Location(const std::string &t_str) {
            this->init();
            this->from_string(t_str);
        }
 
        std::string description() {
#ifdef USE_WB_LOCATION_C_CONVERSION
            char buffer[LOCATION_DESC_BUFFER_SIZE];
            wb_location_description(this, buffer, sizeof(buffer));
            std::string descr = buffer;
            return descr;
#else
            std::ostringstream ss;
            ss << "direction=" << static_cast<signed>(this->direction());
            ss << ", ";
            ss << "distance=" << static_cast<unsigned>(this->distance());
            ss << ", ";
            ss << "confidence=" << static_cast<unsigned>(this->confidence());
            ss << ", ";
            ss << "distanceVariance=" << static_cast<unsigned>(this->distanceVariance());
            ss << ", ";
            ss << "directionVariance=" << static_cast<unsigned>(this->directionVariance());
            return ss.str();
#endif 
        }
 
        std::string to_string() {
#ifdef USE_WB_LOCATION_C_CONVERSION
            char buffer[LOCATION_TO_STRING_BUFFER_SIZE];
            wb_location_to_string(this, buffer, sizeof(buffer));
            std::string toString = buffer;
            return toString;
#else
            std::ostringstream ss;
            ss << static_cast<signed>(this->direction());
            ss << ", ";
            ss << static_cast<unsigned>(this->distance());
            ss << ", ";
            ss << static_cast<unsigned>(this->confidence());
            ss << ", ";
            ss << static_cast<unsigned>(this->distanceVariance());
            ss << ", ";
            ss << static_cast<unsigned>(this->directionVariance());
            return ss.str();
#endif 
        }
 
#ifdef USE_WB_LOCATION_C_CONVERSION
        void from_string(const std::string &t_str) {
            wb_location_from_string(this, t_str.c_str());
#else
        void from_string(const std::string &t_str) {
            char * str_cstr = const_cast<char *>(t_str.c_str());
            size_t temp_length = strlen(str_cstr);
            int length = (temp_length <= INT_MAX) ? static_cast<int>(static_cast<ssize_t>(temp_length)) : -1;
            if (length < 1 || length > LOCATION_DESC_BUFFER_SIZE) {
                return;
            }
            char var_str_buffer[LOCATION_DESC_BUFFER_SIZE + 1];
            char* var_str = &var_str_buffer[0];
            char key_buffer[18];
            char* key = &key_buffer[0];
            int bracecount = 0;
            int startVar = 0;
            int index = 0;
            int startKey = 0;
            int endKey = -1;
            int varIndex = 0;
            if (index == 0 && str_cstr[0] == '{') {
                index = 1;
            }
            startVar = index;
            startKey = startVar;
            do {
                for (int i = index; i < length; i++) {
                    index = i + 1;
                    if (bracecount == 0 && str_cstr[i] == '=') {
                        endKey = i - 1;
                        startVar = index;
                        continue;
                    }
                    if (bracecount == 0 && isspace(str_cstr[i])) {
                        startVar = index;
                        if (endKey == -1) {
                            startKey = index;
                        }
                        continue;
                    }
                    if (bracecount == 0 && str_cstr[i] == ',') {
                        index = i - 1;
                        break;
                    }
                    if (str_cstr[i] == '{') {
                        bracecount++;
                        continue;
                    }
                    if (str_cstr[i] == '}') {
                        bracecount--;
                        if (bracecount < 0) {
                            index = i - 1;
                            break;
                        }
                    }
                    if (i == length - 1) {
                        index = i;
                    }
                }
                if (endKey >= startKey && endKey - startKey < length) {
                    strncpy(key, str_cstr + startKey, static_cast<size_t>((endKey - startKey) + 1));
                    key[(endKey - startKey) + 1] = 0;
                } else {
                    key[0] = 0;
                }
                strncpy(var_str, str_cstr + startVar, static_cast<size_t>((index - startVar) + 1));
                var_str[(index - startVar) + 1] = 0;
                bracecount = 0;
                index += 2;
                startVar = index;
                startKey = startVar;
                endKey = -1;
                if (strlen(key) > 0) {
                    if (0 == strcmp("direction", key)) {
                        varIndex = 0;
                    } else if (0 == strcmp("distance", key)) {
                        varIndex = 1;
                    } else if (0 == strcmp("confidence", key)) {
                        varIndex = 2;
                    } else if (0 == strcmp("distanceVariance", key)) {
                        varIndex = 3;
                    } else if (0 == strcmp("directionVariance", key)) {
                        varIndex = 4;
                    } else {
                        varIndex = -1;
                    }
                }
                switch (varIndex) {
                    case -1: { break; }
                    case 0:
                    {
                        this->set_direction(static_cast<int16_t>(atoi(var_str)));
                        break;
                    }
                    case 1:
                    {
                        this->set_distance(static_cast<uint16_t>(atoi(var_str)));
                        break;
                    }
                    case 2:
                    {
                        this->set_confidence(static_cast<uint8_t>(atoi(var_str)));
                        break;
                    }
                    case 3:
                    {
                        this->set_distanceVariance(static_cast<uint32_t>(atoi(var_str)));
                        break;
                    }
                    case 4:
                    {
                        this->set_directionVariance(static_cast<uint32_t>(atoi(var_str)));
                        break;
                    }
                }
                if (varIndex >= 0) {
                    varIndex++;
                }
            } while(index < length);
#endif 
        }
#endif 
 
        Location(const GU::RelativeCoordinate &t_other)
        {
            this->init(
                deg_d_to_i16(t_other.direction()),
                cm_u_to_u16(mm_u_to_cm_u(t_other.distance()))
            );
        }
 
        Location(const GU::RelativeCoordinate &t_other, const uint8_t t_confidence)
        {
            this->init(
                deg_d_to_i16(t_other.direction()),
                cm_u_to_u16(mm_u_to_cm_u(t_other.distance())),
                t_confidence
            );
        }
 
        Location(const GU::RelativeCoordinate &t_other, const uint8_t t_confidence, const uint32_t t_distanceVariance, uint32_t t_directionVariance)
        {
            this->init(
                deg_d_to_i16(t_other.direction()),
                cm_u_to_u16(mm_u_to_cm_u(t_other.distance())),
                t_confidence,
                t_distanceVariance,
                t_directionVariance
            );
        }
 
        GU::RelativeCoordinate relativeCoordinate() const
        {
            return GU::RelativeCoordinate(wb_location_to_rr_coord(*this));
        }
 
        GU::OptionalRelativeCoordinate optionalRelativeCoordinate(const uint8_t minimumConfidence) const
        {
            return GU::OptionalRelativeCoordinate(wb_location_to_opt_rr_coord(*this, minimumConfidence));
        }
 
#if __cplusplus >= 201703L
        std::optional<GU::RelativeCoordinate> relativeCoordinate(const uint8_t minimumConfidence) const
        {
            if (confidence() < minimumConfidence) return std::nullopt;
            return std::optional<GU::RelativeCoordinate>(relativeCoordinate());
        }
#endif
    };
 
} 
 
#endif