trunk/src/profiles.h

/***************************************
 $Header: /home/amb/CVS/routino/src/profiles.h,v 1.7 2009-04-30 17:29:02 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. +*/

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

 float     highway[Way_Unknown];/*+ A floating point preference for travel on the highway. +*/
 invpref_t invpref[Way_Unknown];/*+ A scaling factor for inverse preference for travel on the highway. +*/

 speed_t   speed[Way_Unknown];  /*+ The maximum speed on each type of highway. +*/

 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	amb	83	/***************************************
2	amb	166	$Header: /home/amb/CVS/routino/src/profiles.h,v 1.7 2009-04-30 17:29:02 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	151	This file Copyright 2008,2009 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			Transport transport; /+ The type of transport. +/
37
38			Allowed allow; /+ The type of transport expressed as what must be allowed on a way. +/
39
40	amb	166	float highway[Way_Unknown];/+ A floating point preference for travel on the highway. +/
41			invpref_t invpref[Way_Unknown];/+ A scaling factor for inverse preference for travel on the highway. +/
42	amb	83
43			speed_t speed[Way_Unknown]; /+ The maximum speed on each type of highway. +/
44
45			int oneway; /+ A flag to indicate if one-way restrictions apply. +/
46	amb	138
47			weight_t weight; /+ The minimum weight of the route. +/
48
49			height_t height; /+ The minimum height of vehicles on the route. +/
50			width_t width; /+ The minimum width of vehicles on the route. +/
51			length_t length; /+ The minimum length of vehicles on the route. +/
52	amb	83	}
53			Profile;
54
55
56			/* Functions */
57
58			Profile *GetProfile(Transport transport);
59
60	amb	166	void UpdateProfile(Profile *profile);
61
62	amb	83	void PrintProfile(const Profile *profile);
63
64	amb	129	void PrintProfilesJS(void);
65
66	amb	145	void PrintProfilesPerl(void);
67
68	amb	83	#endif /* PROFILES_H */