trunk/src/profiles.h

/***************************************
 $Header: /home/amb/CVS/routino/src/profiles.h,v 1.15 2010-03-30 17:58:58 amb Exp $

 A header file for the profiles.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2010 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
{
 char      *name;                      /*+ The name of the 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 */

int ParseXMLProfiles(const char *filename);

Profile *GetProfile(const char *name);

void UpdateProfile(Profile *profile);

void PrintProfile(const Profile *profile);

void PrintProfilesXML(void);

void PrintProfilesJSON(void);

void PrintProfilesPerl(void);

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