Statistics
| Branch: | Revision:

scoutos / scout / libscout / src / behaviors / navigationMap.h @ d140fd71

History | View | Annotate | Download (4.54 KB)

1
/**
2
 * Copyright (c) 2011 Colony Project
3
 * 
4
 * Permission is hereby granted, free of charge, to any person
5
 * obtaining a copy of this software and associated documentation
6
 * files (the "Software"), to deal in the Software without
7
 * restriction, including without limitation the rights to use,
8
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the
10
 * Software is furnished to do so, subject to the following
11
 * conditions:
12
 * 
13
 * The above copyright notice and this permission notice shall be
14
 * included in all copies or substantial portions of the Software.
15
 * 
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23
 * OTHER DEALINGS IN THE SOFTWARE.
24
 */
25

    
26
/**
27
 * @file navigationMap.h
28
 * @brief Contains navigation map Behavior declarations and definitions
29
 * 
30
 * Contains functions and definitions for the use of
31
 * navigation map Behavior 
32
 *
33
 * @author Colony Project, CMU Robotics Club
34
 * @author Priya Deo
35
 * @author Lalitha
36
 * @author James
37
 * @author Leon
38
 **/
39

    
40
#ifndef _NAVIGATION_MAP_
41
#define _NAVIGATION_MAP_
42

    
43
#include <cstdlib>
44
#include <queue>
45
#include "../Behavior.h"
46
//#include "lineDrive.h" // Get turn Macros
47

    
48
/** Turn defintions */
49
#define ISTRAIGHT        0
50
#define ILEFT                  1
51
#define IRIGHT                2
52
#define IUTURN                3
53
#define ISPOTTURN 4
54

    
55
#define START_STATE 3
56

    
57
#define DEADEND 255
58
#define ARRAY_SIZE 3
59
#define MAX_NODES 16
60

    
61
#define SPEED 10 //distance_unit per s
62
#define DROPOFF_TIME 10 //seconds
63
#define TURN_TIME 3 //Seconds
64
#define NUM_ROBOTS 2 
65
#define WAIT_TIME (TURN_TIME * NUM_ROBOTS) //Seconds
66
 
67
/** used to extract information from an encoded Edge */
68
#define GET_EDGE_DIR(edge) ((edge)&0xF)
69
#define GET_EDGE_STATE(edge) (((edge)>>4)&0xFF)
70
#define GET_EDGE_DIST(edge) (((edge)>>12)&0xFFFFF)
71

    
72
/** used to change or build an Edge's information */
73
#define SET_EDGE_DIR(dir) ((dir)&0xF)
74
#define SET_EDGE_STATE(state) (((state)&0xFF)<<4)
75
#define SET_EDGE_DIST(dist) (((dist)&0xFFFFF)<<12)
76

    
77
#define MAKE_EDGE(dir, state, dist) \
78
  SET_EDGE_DIR(dir)+SET_EDGE_STATE(state)+SET_EDGE_DIST(dist)
79

    
80
/** an integer with a direction, an associated state, and distance
81
 *  encoded into its bits*/
82
typedef unsigned int Edge;
83

    
84
/** a simple number representing the number of a node*/
85
typedef unsigned int State;
86

    
87
/** a number representing a type of turn, as defined above*/
88
typedef unsigned int Turn;
89

    
90
/** a list of turns to follow a path */
91
typedef struct{
92
  int len;
93
  Turn* path;
94
} Path;
95

    
96
class navigationMap : Behavior
97
{
98
  /** ASCII Representation of the map
99
   *
100
   *   1           2          3         4
101
   *  ----|-----------|----------|---------|---------->
102
   *  <---|--5--------|--6-------|--7------|--8-------
103
   *      |           |          |         |
104
   *     9|         10|        11|       12|
105
   *      |           |          |         |
106
   *     ---13       ---14      ---15     ---16
107
   */
108

    
109
  public:
110
    /** Initializes the navigation map */
111
    navigationMap(std::string scoutname, Sensors* sensors);
112
    /** Goes through and frees all allocated memory */
113
    ~navigationMap();
114

    
115
    /** FSM implementation */
116
    void run();
117
    
118
    /** sets the current state to the state associated with the turn made */
119
    State update_state(Turn turn_made);
120

    
121
    /** returns the predicted time of arrival for our current task */
122
    Time get_eta();
123
    /** returns the predicted amount of time it will take to finish our task */
124
    Duration get_time_remaining();
125

    
126
    /** returns the Edges connecting from a given State */
127
    Edge* get_outbound_edges(State state);  
128

    
129
    /** returns the current state of the scout in the map*/
130
    State get_state();
131
    /** uses BFS to find the shortest path to a target State node */
132
    Path shortest_path(State start_state, State target_state);
133
    Path shortest_path(State target_state);
134

    
135
    /** returns the predicted worst case time it will take to travel from src to dest nodes */
136
    Duration get_worst_case_time(State start_state, State target_state);
137

    
138
  private:
139
    /** the dynamic array of edge arrays representing individual State nodes */
140
    std::vector <Edge*> map;
141
    /** the current State node */
142
    State curr_state;
143
    /** the predicted time of arrival for our current task */
144
    Time arrival_time;
145
};
146
#endif