wb_location.h

Go to the documentation of this file.

/*
 * file wb_location.h
 *
 * 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 wb_location_h
#define wb_location_h
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wreserved-id-macro"
 
#ifdef __linux
# ifndef _POSIX_SOURCE
#  define _POSIX_SOURCE 200112L
# endif
#endif
#ifndef _XOPEN_SOURCE
# define _XOPEN_SOURCE 700
#endif
#ifdef __APPLE__
# ifndef _DARWIN_C_SOURCE
#  define _DARWIN_C_SOURCE 200112L
# endif
# ifndef __DARWIN_C_LEVEL
#  define __DARWIN_C_LEVEL 200112L
# endif
#endif
 
#pragma clang diagnostic pop
 
#include <gu_util.h>
#include <stdint.h>
 
#include <stdint.h>
#include <guunits/guunits.h>
#include <gucoordinates/gucoordinates.h>
 
#define LOCATION_GENERATED 
#define LOCATION_C_STRUCT wb_location 
#define LOCATION_NUMBER_OF_VARIABLES 5
 
#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
#define LOCATION_DESC_BUFFER_SIZE 108
#define LOCATION_TO_STRING_BUFFER_SIZE 43
#endif 
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct wb_location
{
 
    int16_t direction;
 
    uint16_t distance;
 
    uint8_t confidence;
 
    uint32_t distanceVariance;
 
    uint32_t directionVariance;
 
};
 
#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
 
const char* wb_location_description(const struct wb_location* self, char* descString, size_t bufferSize);
 
const char* wb_location_to_string(const struct wb_location* self, char* toString, size_t bufferSize);
 
struct wb_location* wb_location_from_string(struct wb_location* self, const char* str);
 
#endif 
 
struct wb_location rr_coord_to_wb_location(const gu_relative_coordinate coord, const uint8_t confidence, const uint32_t distanceVariance, const uint32_t directionVariance);
 
struct gu_relative_coordinate wb_location_to_rr_coord(const struct wb_location location);
 
struct gu_optional_relative_coordinate wb_location_to_opt_rr_coord(const struct wb_location location, const uint8_t confidence);
 
/*#ifdef WHITEBOARD_SERIALISATION*/
 
size_t wb_location_to_network_serialised(const struct wb_location *self, char *dst);
 
size_t wb_location_from_network_serialised(const char *src, struct wb_location *dst);
 
/*#endif /// WHITEBOARD_SERIALISATION*/
 
#ifdef __cplusplus
}
#endif
 
#endif