3 * This file is a part of LEMON, a generic C++ optimization library
5 * Copyright (C) 2003-2006
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
22 #include <all_include.h>
24 #include <libgnomecanvasmm.h>
28 ///class MapStorage handles NodeMaps and EdgeMaps.
30 ///Class MapStorage is responsible for storing
31 ///NodeMaps and EdgeMaps that can be shown later
32 ///on GUI. Therefore maps can be added to it,
33 ///and datas over the added maps can be queried.
34 ///The maps will be stored in an std::map,
35 ///referenced with their names. Unfortunately at
36 ///the moment it works only with double type maps
38 ///\todo too many things are public!!
42 std::string background_file_name;
44 double background_scaling;
47 void setBackground(const std::string& file_name);
48 const std::string& getBackgroundFilename();
49 bool isBackgroundSet();
50 double getBackgroundScaling();
51 void setBackgroundScaling(double scaling);
52 ///The graph for which the datas are stored.
54 /// the coordinates of the nodes
55 XYMap<Graph::NodeMap<double> > coords;
56 /// the coordinates of the arrows on the edges
57 XYMap<Graph::EdgeMap<double> > arrow_pos;
59 ///The content of the object has changed, update is needed.
62 ///Name of file loaded in object.
63 std::string file_name;
65 ///Stores double type NodeMaps
66 std::map< std::string,Graph::NodeMap<double> * > nodemap_storage;
68 ///Stores double type EdgeMaps
69 std::map< std::string,Graph::EdgeMap<double> * > edgemap_storage;
71 ///Stores the default values for the different visualization node attributes
72 std::vector<Graph::NodeMap<double> > default_nodemaps;
74 ///Stores the default values for the different visualization edge attributes
75 std::vector<Graph::EdgeMap<double> > default_edgemaps;
77 ///Stores the active maps for the different visualization node attributes
78 std::vector< std::string > active_nodemaps;
80 /// Stores the active maps for the different visualization edge attributes
81 std::vector< std::string > active_edgemaps;
83 /// Default values for the maps
84 std::map< std::string, double > nodemap_default;
86 /// Default values for the maps
87 std::map< std::string, double > edgemap_default;
89 bool arrow_pos_read_ok;
93 /// Signal emitted on any change made on map values
95 /// Signal emitted if the visualization of the maps might have to be updated.
96 /// bool shows us whether the changed map is edge or nodemap.
97 /// int tells us the refreshed property
98 sigc::signal<void, bool, int> signal_prop;
100 /// Signal emitted in the case of nodemap addition
102 /// std::string is the
103 ///name of the new map
104 sigc::signal<void, std::string> signal_node_map;
106 /// Signal emitted in the case of edgemap addition
108 /// std::string is the
109 ///name of the new map
110 sigc::signal<void, std::string> signal_edge_map;
112 /// Signal emitted, when entry in \ref MapWin should be changed.
113 sigc::signal<void, bool, int, std::string> signal_map_win;
115 /// Signal emitted, when entry in \ref DesignWin should be changed.
116 sigc::signal<void, double, double, int> signal_design_win;
118 ///Iteration number during graph design
121 ///Attraction factor during graph design
124 ///Propulsation factor during graph design
128 ///Constructor of MapStorage.
130 ///Its all activity is initializing default values
131 ///for different visualization attributes.
132 MapStorage(NoteBookTab& tab);
134 ///Destructor of MapStorage
136 ///Maps stored here are created with new. Destructor
137 ///deletes them to free up the reserved memory.
140 /// Registrates if the shown map by any attribute has changed to another.
142 ///It handles the \ref active_edgemaps and
143 ///\ref active_nodemaps vectors. It also emits \ref signal_prop signal to let
144 ///know the interested objects that the visible map of a certain
145 ///attribute has changed.
146 ///\param itisedge edgemap or nodemap has changed
147 ///\param prop the property of which the map is changed
148 ///\param mapname the visible map
149 void changeActiveMap(bool itisedge , int prop , std::string mapname);
151 ///Emits signals that let change the active maps in \ref MapWin.
152 void broadcastActiveMaps();
154 /// Returns the active edgemap shown by a visualization property.
156 /// \param prop is the property
157 ///that shows the requested map.
158 std::string getActiveEdgeMap(int prop);
160 /// Returns the active nodemap shown by a visualization property.
162 /// \param prop is the property
163 ///that shows the requested map.
164 std::string getActiveNodeMap(int prop);
166 /// Returns the names of the edgemaps stored here.
167 std::vector<std::string> getEdgeMapList();
169 /// Returns the names of the nodemaps stored here.
170 std::vector<std::string> getNodeMapList();
172 ///returns \ref signal_prop to be able to connect functions to it
173 sigc::signal<void, bool, int> signal_prop_ch();
175 ///returns \ref signal_node_map to be able to connect functions to it
176 sigc::signal<void, std::string> signal_node_map_ch(){return signal_node_map;};
178 ///returns \ref signal_edge_map to be able to connect functions to it
179 sigc::signal<void, std::string> signal_edge_map_ch(){return signal_edge_map;};
181 ///returns \ref signal_map_win to be able to connect functions to it
182 sigc::signal<void, bool, int, std::string> signal_map_win_ch(){return signal_map_win;};
184 ///returns \ref signal_design_win to be able to connect functions to it
185 sigc::signal<void, double, double, int> signal_design_win_ch(){return signal_design_win;};
187 ///Adds given map to storage.
189 ///A name and the map itself has to be provided.
190 ///\param mapname is the name of map
191 ///\param nodemap is the pointer of the given nodemap
192 ///\param def the default value of the map. If not given, it will be 0.
193 ///If new edge is added to graph the value of it in the map will be this.
194 ///\todo map should be given by reference!
195 ///\todo why is default value stored?
196 int addNodeMap(const std::string & mapname,Graph::NodeMap<double> * nodemap, double def=0.0);
198 ///Adds given map to storage. A name and the map itself has to be provided.
200 ///A name and the map itself has to be provided.
201 ///\param mapname is the name of map
202 ///\param edgemap is the pointer of the given edgemap
203 ///\param def the default value of the map. If not given, it will be 0.
204 ///If new edge is added to graph the value of it in the map will be this.
205 ///\todo map should be given by reference!
206 int addEdgeMap(const std::string & mapname,Graph::EdgeMap<double> * edgemap, double def=0.0);
208 ///Returns how much nodemaps is stored in \ref MapStorage
209 int numOfNodeMaps() {return nodemap_storage.size();};
211 ///Returns how much edgemaps is stored in \ref MapStorage
212 int numOfEdgeMaps() {return edgemap_storage.size();};
214 ///Returns the maximum value of the given NodeMap.
216 ///NodeMap has to be given by its name.
217 ///\param name the name of map of which maximum is searched
218 double maxOfNodeMap(const std::string & name);
220 ///Returns the maximum value of the given EdgeMap.
222 ///EdgeMap has to be given by its name.
223 ///\param name the name of map of which maximum is searched
224 double maxOfEdgeMap(const std::string & name);
226 ///Returns the minimum value of the given NodeMap.
228 ///NodeMap has to be given by its name.
229 ///\param name the name of map of which minimum is searched
230 double minOfNodeMap(const std::string & name);
232 ///Returns the minimum value of the given EdgeMap.
234 ///EdgeMap has to be given by its name.
235 ///\param name the name of map of which minimum is searched
236 double minOfEdgeMap(const std::string & name);
238 ///Returns iterator pointing to the first NodeMap in storage.
240 ///To be able to iterate through each maps this function
241 ///returns an iterator pointing to the first nodemap in
243 std::map< std::string,Graph::NodeMap<double> * >::iterator beginOfNodeMaps(){return nodemap_storage.begin();};
245 ///Returns iterator pointing to the first EdgeMap in storage.
247 ///To be able to iterate through each maps this function
248 ///returns an iterator pointing to the first edgemap in
250 std::map< std::string,Graph::EdgeMap<double> * >::iterator beginOfEdgeMaps(){return edgemap_storage.begin();};
252 ///Returns iterator pointing after the last NodeMap in storage.
254 ///To be able to iterate through each maps this function
255 ///returns an iterator pointing to the last nodemap in the storage.
256 std::map< std::string,Graph::NodeMap<double> * >::iterator endOfNodeMaps(){return nodemap_storage.end();};
258 ///Returns iterator pointing after the last EdgeMap in storage.
260 ///To be able to iterate through each maps this function
261 ///returns an iterator pointing to the last edgemap in the storage.
262 std::map< std::string,Graph::EdgeMap<double> * >::iterator endOfEdgeMaps(){return edgemap_storage.end();};
264 ///Emits \ref signal_prop if mapvalues have changed, and MapStorage gets to know it.
266 ///If values in a map have changed, this function checks, whether it is displayed.
267 ///This check means searching the given mapname between active maps
268 ///(\ref active_nodemaps, \ref active_edgemaps). If it is there at a certain property,
269 ///it emits a signal with the property, where the gotten mapname was found. One signal
270 ///is emitted for each property displaying the given map.
271 ///\param itisedge whether the map an edgemap or nodemap
272 ///\param mapname name of map to visualize
273 void mapChanged(bool itisedge, std::string mapname);
275 ///Read datas from the given filename.
276 int readFromFile(const std::string &);
278 ///Save datas to the given filename.
279 void writeToFile(const std::string &);
281 ///Deletes all datastructures stored here.
284 void ArrowPosReadOK();
286 void get_design_data(double &, double &, int &);
287 void set_attraction(double);
288 void set_propulsation(double);
289 void set_iteration(int);
291 void redesign_data_changed();
293 void exportGraphToEPS(std::vector<bool>, std::string);
296 #endif //MAPSTORAGE_H