trunk/src/profiles.h

/***************************************
 $Header: /home/amb/CVS/routino/src/profiles.h,v 1.12 2009-11-25 15:00:37 amb Exp $

 A header file for the profiles.

 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 PROFILES_H
#define PROFILES_H    /*+ To stop multiple inclusions. +*/

#include "types.h"


/* Data structures */

/*+ A data structure to hold a transport type profile. +*/
typedef struct _Profile
{
 Transport  transport;                 /*+ The type of transport. +*/

 wayallow_t allow;                     /*+ The type of transport expressed as what must be allowed on a way. +*/

 score_t    highway[Way_Count];        /*+ A floating point preference for travel on the highway. +*/
 score_t    max_pref;                  /*+ The maximum preference for any highway type. +*/

 speed_t    speed[Way_Count];          /*+ The maximum speed on each type of highway. +*/
 speed_t    max_speed;                 /*+ The maximum speed for any highway type. +*/

 score_t    props_yes[Property_Count]; /*+ A floating point preference for ways with this attribute. +*/
 score_t    props_no [Property_Count]; /*+ A floating point preference for ways without this attribute. +*/

 int        oneway;                    /*+ A flag to indicate if one-way restrictions apply. +*/

 weight_t   weight;                    /*+ The minimum weight of the route. +*/

 height_t   height;                    /*+ The minimum height of vehicles on the route. +*/
 width_t    width;                     /*+ The minimum width of vehicles on the route. +*/
 length_t   length;                    /*+ The minimum length of vehicles on the route. +*/
}
 Profile;


/* Functions */

Profile *GetProfile(Transport transport);

void UpdateProfile(Profile *profile);

void PrintProfile(const Profile *profile);

void PrintProfilesJS(void);

void PrintProfilesPerl(void);

#endif /* PROFILES_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/profiles.h,v 1.12 2009-11-25 15:00:37 amb Exp $
3
4	A header file for the profiles.
5
6	Part of the Routino routing software.
7	****************/ /****************
8	This file Copyright 2008,2009 Andrew M. Bishop
9
10	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	***************************************/
23
24
25	#ifndef PROFILES_H
26	#define PROFILES_H /+ To stop multiple inclusions. +/
27
28	#include "types.h"
29
30
31	/* Data structures */
32
33	/+ A data structure to hold a transport type profile. +/
34	typedef struct _Profile
35	{
36	Transport transport; /+ The type of transport. +/
37
38	wayallow_t allow; /+ The type of transport expressed as what must be allowed on a way. +/
39
40	score_t highway[Way_Count]; /+ A floating point preference for travel on the highway. +/
41	score_t max_pref; /+ The maximum preference for any highway type. +/
42
43	speed_t speed[Way_Count]; /+ The maximum speed on each type of highway. +/
44	speed_t max_speed; /+ The maximum speed for any highway type. +/
45
46	score_t props_yes[Property_Count]; /+ A floating point preference for ways with this attribute. +/
47	score_t props_no [Property_Count]; /+ A floating point preference for ways without this attribute. +/
48
49	int oneway; /+ A flag to indicate if one-way restrictions apply. +/
50
51	weight_t weight; /+ The minimum weight of the route. +/
52
53	height_t height; /+ The minimum height of vehicles on the route. +/
54	width_t width; /+ The minimum width of vehicles on the route. +/
55	length_t length; /+ The minimum length of vehicles on the route. +/
56	}
57	Profile;
58
59
60	/* Functions */
61
62	Profile *GetProfile(Transport transport);
63
64	void UpdateProfile(Profile *profile);
65
66	void PrintProfile(const Profile *profile);
67
68	void PrintProfilesJS(void);
69
70	void PrintProfilesPerl(void);
71
72	#endif /* PROFILES_H */