trunk/src/ways.h

/***************************************
 $Header: /home/amb/CVS/routino/src/ways.h,v 1.33 2009-11-02 19:32:06 amb Exp $

 A header file for the ways.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008,2009 Andrew M. Bishop

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************/


#ifndef WAYS_H
#define WAYS_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "types.h"


/* Data structures */


/*+ A structure containing a single way (members ordered to minimise overall size). +*/
struct _Way
{
 index_t    name;               /*+ The offset of the name of the way in the names array. +*/

 wayallow_t allow;              /*+ The type of traffic allowed on the way. +*/

 waytype_t  type;               /*+ The highway type of the way. +*/

 wayprop_t  props;              /*+ The properties of the way. +*/

 speed_t    speed;              /*+ The defined maximum speed limit of the way. +*/

 weight_t   weight;             /*+ The defined maximum weight of traffic on the way. +*/
 height_t   height;             /*+ The defined maximum height of traffic on the way. +*/
 width_t    width;              /*+ The defined maximum width of traffic on the way. +*/
 length_t   length;             /*+ The defined maximum length of traffic on the way. +*/
};


/*+ A structure containing a set of ways (mmap format). +*/
struct _Ways
{
 uint32_t number;               /*+ How many ways are stored? +*/
 uint32_t onumber;              /*+ How many ways were there originally? +*/

 Way     *ways;                 /*+ An array of ways. +*/
 char    *names;                /*+ An array of characters containing the names. +*/

 void    *data;                 /*+ The memory mapped data. +*/
};


/* Macros */


/*+ Return a Way* pointer given a set of ways and an index. +*/
#define LookupWay(xxx,yyy)     (&(xxx)->ways[yyy])

/*+ Return the name of a way given the Way pointer and a set of ways. +*/
#define WayName(xxx,yyy)       (&(xxx)->names[(yyy)->name])


/* Functions */


Ways *LoadWayList(const char *filename);

Highway HighwayType(const char *highway);
Transport TransportType(const char *transport);
Property PropertyType(const char *property);

const char *HighwayName(Highway highway);
const char *TransportName(Transport transport);
const char *PropertyName(Property property);

const char *AllowedNameList(wayallow_t allowed);
const char *PropertiesNameList(wayprop_t properties);

const char *HighwayList(void);
const char *TransportList(void);
const char *PropertyList(void);

int WaysCompare(Way *way1,Way *way2);


#endif /* WAYS_H */
1	amb	21	/***************************************
2	amb	298	$Header: /home/amb/CVS/routino/src/ways.h,v 1.33 2009-11-02 19:32:06 amb Exp $
3	amb	21
4			A header file for the ways.
5	amb	151
6			Part of the Routino routing software.
7	amb	21	****************/ /****************
8	amb	151	This file Copyright 2008,2009 Andrew M. Bishop
9	amb	21
10	amb	151	This program is free software: you can redistribute it and/or modify
11			it under the terms of the GNU Affero General Public License as published by
12			the Free Software Foundation, either version 3 of the License, or
13			(at your option) any later version.
14
15			This program is distributed in the hope that it will be useful,
16			but WITHOUT ANY WARRANTY; without even the implied warranty of
17			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			GNU Affero General Public License for more details.
19
20			You should have received a copy of the GNU Affero General Public License
21			along with this program. If not, see <http://www.gnu.org/licenses/>.
22	amb	21	***************************************/
23
24
25			#ifndef WAYS_H
26			#define WAYS_H /+ To stop multiple inclusions. +/
27
28			#include <stdint.h>
29
30	amb	109	#include "types.h"
31	amb	21
32
33			/* Data structures */
34
35
36	amb	298	/+ A structure containing a single way (members ordered to minimise overall size). +/
37	amb	109	struct _Way
38	amb	87	{
39	amb	109	index_t name; /+ The offset of the name of the way in the names array. +/
40	amb	87
41	amb	296	wayallow_t allow; /+ The type of traffic allowed on the way. +/
42
43	amb	298	waytype_t type; /+ The highway type of the way. +/
44	amb	109
45	amb	298	wayprop_t props; /+ The properties of the way. +/
46
47	amb	135	speed_t speed; /+ The defined maximum speed limit of the way. +/
48
49			weight_t weight; /+ The defined maximum weight of traffic on the way. +/
50			height_t height; /+ The defined maximum height of traffic on the way. +/
51			width_t width; /+ The defined maximum width of traffic on the way. +/
52			length_t length; /+ The defined maximum length of traffic on the way. +/
53	amb	109	};
54
55
56	amb	21	/+ A structure containing a set of ways (mmap format). +/
57	amb	109	struct _Ways
58	amb	21	{
59	amb	232	uint32_t number; /+ How many ways are stored? +/
60			uint32_t onumber; /+ How many ways were there originally? +/
61	amb	87
62	amb	228	Way ways; /+ An array of ways. +*/
63	amb	87	char names; /+ An array of characters containing the names. +*/
64
65			void data; /+ The memory mapped data. +*/
66	amb	109	};
67	amb	21
68
69	amb	109	/* Macros */
70	amb	21
71
72	amb	109	/+ Return a Way pointer given a set of ways and an index. +*/
73			#define LookupWay(xxx,yyy) (&(xxx)->ways[yyy])
74	amb	21
75	amb	109	/+ Return the name of a way given the Way pointer and a set of ways. +/
76			#define WayName(xxx,yyy) (&(xxx)->names[(yyy)->name])
77	amb	21
78
79	amb	109	/* Functions */
80	amb	21
81
82	amb	109	Ways LoadWayList(const char filename);
83	amb	21
84	amb	74	Highway HighwayType(const char *highway);
85			Transport TransportType(const char *transport);
86	amb	298	Property PropertyType(const char *property);
87	amb	21
88	amb	82	const char *HighwayName(Highway highway);
89			const char *TransportName(Transport transport);
90	amb	298	const char *PropertyName(Property property);
91	amb	82
92	amb	298	const char *AllowedNameList(wayallow_t allowed);
93			const char *PropertiesNameList(wayprop_t properties);
94
95	amb	75	const char *HighwayList(void);
96			const char *TransportList(void);
97	amb	298	const char *PropertyList(void);
98	amb	75
99	amb	201	int WaysCompare(Way way1,Way way2);
100	amb	32
101	amb	181
102	amb	21	#endif /* WAYS_H */