gusimplewhiteboard
wb_line_sighting.h
Go to the documentation of this file.
1/*
2 * file wb_line_sighting.h
3 *
4 * This file was generated by classgenerator from line_sighting.gen.
5 * DO NOT CHANGE MANUALLY!
6 *
7 * Copyright © 2021 Callum McColl. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above
17 * copyright notice, this list of conditions and the following
18 * disclaimer in the documentation and/or other materials
19 * provided with the distribution.
20 *
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgement:
23 *
24 * This product includes software developed by Callum McColl.
25 *
26 * 4. Neither the name of the author nor the names of contributors
27 * may be used to endorse or promote products derived from this
28 * software without specific prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
34 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
35 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
36 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
37 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
38 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
39 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
40 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 *
42 * -----------------------------------------------------------------------
43 * This program is free software; you can redistribute it and/or
44 * modify it under the above terms or under the terms of the GNU
45 * General Public License as published by the Free Software Foundation;
46 * either version 2 of the License, or (at your option) any later version.
47 *
48 * This program is distributed in the hope that it will be useful,
49 * but WITHOUT ANY WARRANTY; without even the implied warranty of
50 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
51 * GNU General Public License for more details.
52 *
53 * You should have received a copy of the GNU General Public License
54 * along with this program; if not, see http://www.gnu.org/licenses/
55 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
56 * Fifth Floor, Boston, MA 02110-1301, USA.
57 *
58 */
59
60#ifndef wb_line_sighting_h
61#define wb_line_sighting_h
62
63#pragma clang diagnostic push
64#pragma clang diagnostic ignored "-Wreserved-id-macro"
65
66#ifdef __linux
67# ifndef _POSIX_SOURCE
68# define _POSIX_SOURCE 200112L
69# endif
70#endif
71#ifndef _XOPEN_SOURCE
72# define _XOPEN_SOURCE 700
73#endif
74#ifdef __APPLE__
75# ifndef _DARWIN_C_SOURCE
76# define _DARWIN_C_SOURCE 200112L
77# endif
78# ifndef __DARWIN_C_LEVEL
79# define __DARWIN_C_LEVEL 200112L
80# endif
81#endif
82
83#pragma clang diagnostic pop
84
85#include <gu_util.h>
86#include <stdint.h>
87
88#include "wb_polar_coordinate.h"
89
93};
94
95#define LINE_SIGHTING_GENERATED
96#define LINE_SIGHTING_C_STRUCT wb_line_sighting
97#define LINE_SIGHTING_NUMBER_OF_VARIABLES 3
98
99#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
100#define LINE_SIGHTING_DESC_BUFFER_SIZE 1575
101#define LINE_SIGHTING_TO_STRING_BUFFER_SIZE 1541
102#endif
103
104#ifdef __cplusplus
105extern "C" {
106#endif
107
112{
113
118
123
128
129};
130
131#ifdef WHITEBOARD_POSTER_STRING_CONVERSION
132
136const char* wb_line_sighting_description(const struct wb_line_sighting* self, char* descString, size_t bufferSize);
137
141const char* wb_line_sighting_to_string(const struct wb_line_sighting* self, char* toString, size_t bufferSize);
142
146struct wb_line_sighting* wb_line_sighting_from_string(struct wb_line_sighting* self, const char* str);
147
148#endif
149
150/*#ifdef WHITEBOARD_SERIALISATION*/
151
155size_t wb_line_sighting_to_network_serialised(const struct wb_line_sighting *self, char *dst);
156
160size_t wb_line_sighting_from_network_serialised(const char *src, struct wb_line_sighting *dst);
161
162/*#endif /// WHITEBOARD_SERIALISATION*/
163
164#ifdef __cplusplus
165}
166#endif
167
168#endif
WHITEBOARD_POSTER_STRING_CONVERSION.
enum LineSightingType sightingType
The type of sighting.
struct wb_polar_coordinate rightPoint
The right/top point of the line.
struct wb_polar_coordinate leftPoint
The left/bottom point of the line.
WHITEBOARD_POSTER_STRING_CONVERSION.
const char * wb_line_sighting_description(const struct wb_line_sighting *self, char *descString, size_t bufferSize)
Convert to a description string.
LineSightingType
@ HorizonLineSightingType
@ FieldLineSightingType
size_t wb_line_sighting_to_network_serialised(const struct wb_line_sighting *self, char *dst)
WHITEBOARD_POSTER_STRING_CONVERSION.
const char * wb_line_sighting_to_string(const struct wb_line_sighting *self, char *toString, size_t bufferSize)
Convert to a string.
size_t wb_line_sighting_from_network_serialised(const char *src, struct wb_line_sighting *dst)
Network stream deserialisation.
struct wb_line_sighting * wb_line_sighting_from_string(struct wb_line_sighting *self, const char *str)
Convert from a string.