SVN checkout 11/12/2010
[monav:monav.git] / interfaces / irouter.h
1 /*
2 Copyright 2010  Christian Vetter veaac.fdirct@gmail.com
3
4 This file is part of MoNav.
5
6 MoNav is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 MoNav is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with MoNav.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef IROUTER_H
21 #define IROUTER_H
22
23 #include "utils/config.h"
24 #include "utils/coordinates.h"
25 #include "interfaces/igpslookup.h"
26 #include <QtPlugin>
27 #include <QVector>
28
29 class IRouter
30 {
31 public:
32
33         struct Node {
34                 Node(){}
35                 Node( UnsignedCoordinate coord )
36                 {
37                         coordinate = coord;
38                 }
39
40                 UnsignedCoordinate coordinate;
41         };
42
43         struct Edge {
44                 Edge(){}
45                 Edge( unsigned name_, bool branchingPossible_, unsigned char type_, unsigned short length_, unsigned seconds_ )
46                 {
47                         name = name_;
48                         branchingPossible = branchingPossible_;
49                         type = type_;
50                         length = length_;
51                         seconds = seconds_;
52                 }
53                 unsigned name : 30; // name ID of the edge
54                 bool branchingPossible : 1; // is there more than one subsequent edge to traverse ( turing around and traversing this edge in the opposite direction does not count )
55                 unsigned char type; // type ID of the edge
56                 unsigned short length; // the amount of path nodes - 1 == amount of edges
57                 unsigned seconds;
58         };
59
60         virtual ~IRouter() {}
61
62         virtual QString GetName() = 0;
63         virtual void SetInputDirectory( const QString& dir ) = 0;
64         virtual void ShowSettings() = 0;
65         virtual bool IsCompatible( int fileFormatVersion ) = 0;
66         virtual bool LoadData() = 0;
67         // computes the route between source and target and returns the distance in second
68         virtual bool GetRoute( double* distance, QVector< Node>* pathNodes, QVector< Edge >* pathEdges, const IGPSLookup::Result& source, const IGPSLookup::Result& target ) = 0;
69         // translate a name ID into the corresponding string
70         virtual bool GetName( QString* result, unsigned name ) = 0;
71         // translate a list of name IDs into the corresponding strings
72         virtual bool GetNames( QVector< QString >* result, QVector< unsigned > names ) = 0;
73         // translate a type ID into the corresponding description
74         virtual bool GetType( QString* result, unsigned type ) = 0;
75         // translate a list of type IDs into the corresponding descriptions
76         virtual bool GetTypes( QVector< QString >* result, QVector< unsigned > types ) = 0;
77 };
78
79 Q_DECLARE_INTERFACE( IRouter, "monav.IRouter/1.1" )
80
81 #endif // IROUTER_H