8 #include "all_include.h"
10 #include <libgnomecanvasmm.h>
12 ///class MapStorage handles NodeMaps and EdgeMaps.
14 ///Class MapStorage is responsible for storing
15 ///NodeMaps and EdgeMaps that can be shown later
16 ///on GUI. Therefore maps can be added to it,
17 ///and datas over the added maps can be queried.
18 ///The maps will be stored in an std::map,
19 ///referenced with their names. Unfortunately at
20 ///the moment it works only with double type maps
22 ///\todo too many things are public!!
26 enum value {DOUBLE, STRING};
27 enum type {NORMAL, GUI};
29 ///The graph for which the datas are stored.
31 /// the coordinates of the nodes
32 XYMap<Graph::NodeMap<double> > coords;
33 /// the coordinates of the arrows on the edges
34 XYMap<Graph::EdgeMap<double> > arrow_pos;
36 ///The content of the object has changed, update is needed.
39 ///Name of file loaded in object.
40 std::string file_name;
42 ///Stores double type NodeMaps
43 std::map< std::string,Graph::NodeMap<double> * > nodemap_storage;
45 ///Stores double type EdgeMaps
46 std::map< std::string,Graph::EdgeMap<double> * > edgemap_storage;
48 ///Stores the default values for the different visualization node attributes
49 std::vector<Graph::NodeMap<double> > default_nodemaps;
51 ///Stores the default values for the different visualization edge attributes
52 std::vector<Graph::EdgeMap<double> > default_edgemaps;
54 ///Stores the active maps for the different visualization node attributes
55 std::vector< std::string > active_nodemaps;
57 /// Stores the active maps for the different visualization edge attributes
58 std::vector< std::string > active_edgemaps;
60 /// Default values for the maps
61 std::map< std::string, double > nodemap_default;
63 /// Default values for the maps
64 std::map< std::string, double > edgemap_default;
66 bool arrow_pos_read_ok;
69 /// type of the signal emitted if the visualization of the maps might have to be updated.
71 /// bool shows us whether the changed map is edge or nodemap.
72 /// int tells us the refreshed property
73 typedef sigc::signal<void, bool, int> Signal_Prop;
75 /// Signal emitted on any change made on map values
76 Signal_Prop signal_prop;
78 /// Signal emitted in the case of nodemap addition
80 /// std::string is the
81 ///name of the new map
82 sigc::signal<void, std::string> signal_node_map;
84 /// Signal emitted in the case of edgemap addition
86 /// std::string is the
87 ///name of the new map
88 sigc::signal<void, std::string> signal_edge_map;
90 /// Signal emitted, when entry in \ref MapWin should be changed.
91 sigc::signal<void, bool, int, std::string> signal_map_win;
94 ///Constructor of MapStorage.
96 ///Its all activity is initializing default values
97 ///for different visualization attributes.
100 ///Destructor of MapStorage
102 ///Maps stored here are created with new. Destructor
103 ///deletes them to free up the reserved memory.
106 /// Registrates if the shown map by any attribute has changed to another.
108 ///It handles the \ref active_edgemaps and
109 ///\ref active_nodemaps vectors. It also emits \ref signal_prop signal to let
110 ///know the interested objects that the visible map of a certain
111 ///attribute has changed.
112 ///\param itisedge edgemap or nodemap has changed
113 ///\param prop the property of which the map is changed
114 ///\param mapname the visible map
115 void changeActiveMap(bool itisedge , int prop , std::string mapname);
117 ///Emits signals that let change the active maps in \ref MapWin.
118 void broadcastActiveMaps();
120 /// Returns the active edgemap shown by a visualization property.
122 /// \param prop is the property
123 ///that shows the requested map.
124 std::string getActiveEdgeMap(int prop);
126 /// Returns the active nodemap shown by a visualization property.
128 /// \param prop is the property
129 ///that shows the requested map.
130 std::string getActiveNodeMap(int prop);
132 /// Returns the names of the edgemaps stored here.
133 std::vector<std::string> getEdgeMapList();
135 /// Returns the names of the nodemaps stored here.
136 std::vector<std::string> getNodeMapList();
138 ///returns \ref signal_prop to be able to connect functions to it
139 Signal_Prop signal_prop_ch();
141 ///returns \ref signal_node_map to be able to connect functions to it
142 sigc::signal<void, std::string> signal_node_map_ch(){return signal_node_map;};
144 ///returns \ref signal_edge_map to be able to connect functions to it
145 sigc::signal<void, std::string> signal_edge_map_ch(){return signal_edge_map;};
147 ///returns \ref signal_map_win to be able to connect functions to it
148 sigc::signal<void, bool, int, std::string> signal_map_win_ch(){return signal_map_win;};
150 ///Adds given map to storage.
152 ///A name and the map itself has to be provided.
153 ///\param mapname is the name of map
154 ///\param nodemap is the pointer of the given nodemap
155 ///\param def the default value of the map. If not given, it will be 0.
156 ///If new edge is added to graph the value of it in the map will be this.
157 ///\todo map should be given by reference!
158 ///\todo why is default value stored?
159 int addNodeMap(const std::string & mapname,Graph::NodeMap<double> * nodemap, double def=0.0);
161 ///Adds given map to storage. A name and the map itself has to be provided.
163 ///A name and the map itself has to be provided.
164 ///\param mapname is the name of map
165 ///\param edgemap is the pointer of the given edgemap
166 ///\param def the default value of the map. If not given, it will be 0.
167 ///If new edge is added to graph the value of it in the map will be this.
168 ///\todo map should be given by reference!
169 int addEdgeMap(const std::string & mapname,Graph::EdgeMap<double> * edgemap, double def=0.0);
171 ///Returns how much nodemaps is stored in \ref MapStorage
172 int numOfNodeMaps() {return nodemap_storage.size();};
174 ///Returns how much edgemaps is stored in \ref MapStorage
175 int numOfEdgeMaps() {return edgemap_storage.size();};
177 ///Returns the maximum value of the given NodeMap.
179 ///NodeMap has to be given by its name.
180 ///\param name the name of map of which maximum is searched
181 double maxOfNodeMap(const std::string & name);
183 ///Returns the maximum value of the given EdgeMap.
185 ///EdgeMap has to be given by its name.
186 ///\param name the name of map of which maximum is searched
187 double maxOfEdgeMap(const std::string & name);
189 ///Returns the minimum value of the given NodeMap.
191 ///NodeMap has to be given by its name.
192 ///\param name the name of map of which minimum is searched
193 double minOfNodeMap(const std::string & name);
195 ///Returns the minimum value of the given EdgeMap.
197 ///EdgeMap has to be given by its name.
198 ///\param name the name of map of which minimum is searched
199 double minOfEdgeMap(const std::string & name);
201 ///Returns iterator pointing to the first NodeMap in storage.
203 ///To be able to iterate through each maps this function
204 ///returns an iterator pointing to the first nodemap in
206 std::map< std::string,Graph::NodeMap<double> * >::iterator beginOfNodeMaps(){return nodemap_storage.begin();};
208 ///Returns iterator pointing to the first EdgeMap in storage.
210 ///To be able to iterate through each maps this function
211 ///returns an iterator pointing to the first edgemap in
213 std::map< std::string,Graph::EdgeMap<double> * >::iterator beginOfEdgeMaps(){return edgemap_storage.begin();};
215 ///Returns iterator pointing after the last NodeMap in storage.
217 ///To be able to iterate through each maps this function
218 ///returns an iterator pointing to the last nodemap in the storage.
219 std::map< std::string,Graph::NodeMap<double> * >::iterator endOfNodeMaps(){return nodemap_storage.end();};
221 ///Returns iterator pointing after the last EdgeMap in storage.
223 ///To be able to iterate through each maps this function
224 ///returns an iterator pointing to the last edgemap in the storage.
225 std::map< std::string,Graph::EdgeMap<double> * >::iterator endOfEdgeMaps(){return edgemap_storage.end();};
227 ///Emits \ref signal_prop if mapvalues have changed, and MapStorage gets to know it.
229 ///If values in a map have changed, this function checks, whether it is displayed.
230 ///This check means searching the given mapname between active maps
231 ///(\ref active_nodemaps, \ref active_edgemaps). If it is there at a certain property,
232 ///it emits a signal with the property, where the gotten mapname was found. One signal
233 ///is emitted for each property displaying the given map.
234 ///\param itisedge whether the map an edgemap or nodemap
235 ///\param mapname name of map to visualize
236 void mapChanged(bool itisedge, std::string mapname);
238 ///Read datas from the given filename.
239 int readFromFile(const std::string &);
241 ///Save datas to the given filename.
242 void writeToFile(const std::string &);
244 ///Deletes all datastructures stored here.
247 void ArrowPosReadOK();
250 #endif //MAPSTORAGE_H