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
24 #include "all_include.h"
26 #include <libgnomecanvasmm.h>
30 ///class MapStorage handles NodeMaps and EdgeMaps.
32 ///Class MapStorage is responsible for storing
33 ///NodeMaps and EdgeMaps that can be shown later
34 ///on GUI. Therefore maps can be added to it,
35 ///and datas over the added maps can be queried.
36 ///The maps will be stored in an std::map,
37 ///referenced with their names. Unfortunately at
38 ///the moment it works only with double type maps
40 ///\todo too many things are public!!
44 std::string background_file_name;
46 double background_scaling;
49 void setBackground(const std::string& file_name);
50 const std::string& getBackgroundFilename();
51 bool isBackgroundSet();
52 double getBackgroundScaling();
53 void setBackgroundScaling(double scaling);
54 ///The graph for which the datas are stored.
56 /// the coordinates of the nodes
57 XYMap<Graph::NodeMap<double> > coords;
58 /// the coordinates of the arrows on the edges
59 XYMap<Graph::EdgeMap<double> > arrow_pos;
61 ///The content of the object has changed, update is needed.
64 ///Name of file loaded in object.
65 std::string file_name;
67 ///Stores double type NodeMaps
68 std::map< std::string,Graph::NodeMap<double> * > nodemap_storage;
70 ///Stores double type EdgeMaps
71 std::map< std::string,Graph::EdgeMap<double> * > edgemap_storage;
73 ///Stores the default values for the different visualization node attributes
74 std::vector<Graph::NodeMap<double> > default_nodemaps;
76 ///Stores the default values for the different visualization edge attributes
77 std::vector<Graph::EdgeMap<double> > default_edgemaps;
79 ///Stores the active maps for the different visualization node attributes
80 std::vector< std::string > active_nodemaps;
82 /// Stores the active maps for the different visualization edge attributes
83 std::vector< std::string > active_edgemaps;
85 /// Default values for the maps
86 std::map< std::string, double > nodemap_default;
88 /// Default values for the maps
89 std::map< std::string, double > edgemap_default;
91 bool arrow_pos_read_ok;
95 /// Signal emitted on any change made on map values
97 /// Signal emitted if the visualization of the maps might have to be updated.
98 /// bool shows us whether the changed map is edge or nodemap.
99 /// int tells us the refreshed property
100 sigc::signal<void, bool, int> signal_prop;
102 /// Signal emitted in the case of nodemap addition
104 /// std::string is the
105 ///name of the new map
106 sigc::signal<void, std::string> signal_node_map;
108 /// Signal emitted in the case of edgemap addition
110 /// std::string is the
111 ///name of the new map
112 sigc::signal<void, std::string> signal_edge_map;
114 /// Signal emitted, when entry in \ref MapWin should be changed.
115 sigc::signal<void, bool, int, std::string> signal_map_win;
117 /// Signal emitted, when entry in \ref DesignWin should be changed.
118 sigc::signal<void, double, double, int> signal_design_win;
120 ///Iteration number during graph design
123 ///Attraction factor during graph design
126 ///Propulsation factor during graph design
130 ///Constructor of MapStorage.
132 ///Its all activity is initializing default values
133 ///for different visualization attributes.
134 MapStorage(NoteBookTab& tab);
136 ///Destructor of MapStorage
138 ///Maps stored here are created with new. Destructor
139 ///deletes them to free up the reserved memory.
142 /// Registrates if the shown map by any attribute has changed to another.
144 ///It handles the \ref active_edgemaps and
145 ///\ref active_nodemaps vectors. It also emits \ref signal_prop signal to let
146 ///know the interested objects that the visible map of a certain
147 ///attribute has changed.
148 ///\param itisedge edgemap or nodemap has changed
149 ///\param prop the property of which the map is changed
150 ///\param mapname the visible map
151 void changeActiveMap(bool itisedge , int prop , std::string mapname);
153 ///Emits signals that let change the active maps in \ref MapWin.
154 void broadcastActiveMaps();
156 /// Returns the active edgemap shown by a visualization property.
158 /// \param prop is the property
159 ///that shows the requested map.
160 std::string getActiveEdgeMap(int prop);
162 /// Returns the active nodemap shown by a visualization property.
164 /// \param prop is the property
165 ///that shows the requested map.
166 std::string getActiveNodeMap(int prop);
168 /// Returns the names of the edgemaps stored here.
169 std::vector<std::string> getEdgeMapList();
171 /// Returns the names of the nodemaps stored here.
172 std::vector<std::string> getNodeMapList();
174 ///returns \ref signal_prop to be able to connect functions to it
175 sigc::signal<void, bool, int> signal_prop_ch();
177 ///returns \ref signal_node_map to be able to connect functions to it
178 sigc::signal<void, std::string> signal_node_map_ch(){return signal_node_map;};
180 ///returns \ref signal_edge_map to be able to connect functions to it
181 sigc::signal<void, std::string> signal_edge_map_ch(){return signal_edge_map;};
183 ///returns \ref signal_map_win to be able to connect functions to it
184 sigc::signal<void, bool, int, std::string> signal_map_win_ch(){return signal_map_win;};
186 ///returns \ref signal_design_win to be able to connect functions to it
187 sigc::signal<void, double, double, int> signal_design_win_ch(){return signal_design_win;};
189 ///Adds given map to storage.
191 ///A name and the map itself has to be provided.
192 ///\param mapname is the name of map
193 ///\param nodemap is the pointer of the given nodemap
194 ///\param def the default value of the map. If not given, it will be 0.
195 ///If new edge is added to graph the value of it in the map will be this.
196 ///\todo map should be given by reference!
197 ///\todo why is default value stored?
198 int addNodeMap(const std::string & mapname,Graph::NodeMap<double> * nodemap, double def=0.0);
200 ///Adds given map to storage. A name and the map itself has to be provided.
202 ///A name and the map itself has to be provided.
203 ///\param mapname is the name of map
204 ///\param edgemap is the pointer of the given edgemap
205 ///\param def the default value of the map. If not given, it will be 0.
206 ///If new edge is added to graph the value of it in the map will be this.
207 ///\todo map should be given by reference!
208 int addEdgeMap(const std::string & mapname,Graph::EdgeMap<double> * edgemap, double def=0.0);
210 ///Returns how much nodemaps is stored in \ref MapStorage
211 int numOfNodeMaps() {return nodemap_storage.size();};
213 ///Returns how much edgemaps is stored in \ref MapStorage
214 int numOfEdgeMaps() {return edgemap_storage.size();};
216 ///Returns the maximum value of the given NodeMap.
218 ///NodeMap has to be given by its name.
219 ///\param name the name of map of which maximum is searched
220 double maxOfNodeMap(const std::string & name);
222 ///Returns the maximum value of the given EdgeMap.
224 ///EdgeMap has to be given by its name.
225 ///\param name the name of map of which maximum is searched
226 double maxOfEdgeMap(const std::string & name);
228 ///Returns the minimum value of the given NodeMap.
230 ///NodeMap has to be given by its name.
231 ///\param name the name of map of which minimum is searched
232 double minOfNodeMap(const std::string & name);
234 ///Returns the minimum value of the given EdgeMap.
236 ///EdgeMap has to be given by its name.
237 ///\param name the name of map of which minimum is searched
238 double minOfEdgeMap(const std::string & name);
240 ///Returns iterator pointing to the first NodeMap in storage.
242 ///To be able to iterate through each maps this function
243 ///returns an iterator pointing to the first nodemap in
245 std::map< std::string,Graph::NodeMap<double> * >::iterator beginOfNodeMaps(){return nodemap_storage.begin();};
247 ///Returns iterator pointing to the first EdgeMap in storage.
249 ///To be able to iterate through each maps this function
250 ///returns an iterator pointing to the first edgemap in
252 std::map< std::string,Graph::EdgeMap<double> * >::iterator beginOfEdgeMaps(){return edgemap_storage.begin();};
254 ///Returns iterator pointing after the last NodeMap in storage.
256 ///To be able to iterate through each maps this function
257 ///returns an iterator pointing to the last nodemap in the storage.
258 std::map< std::string,Graph::NodeMap<double> * >::iterator endOfNodeMaps(){return nodemap_storage.end();};
260 ///Returns iterator pointing after the last EdgeMap in storage.
262 ///To be able to iterate through each maps this function
263 ///returns an iterator pointing to the last edgemap in the storage.
264 std::map< std::string,Graph::EdgeMap<double> * >::iterator endOfEdgeMaps(){return edgemap_storage.end();};
266 ///Emits \ref signal_prop if mapvalues have changed, and MapStorage gets to know it.
268 ///If values in a map have changed, this function checks, whether it is displayed.
269 ///This check means searching the given mapname between active maps
270 ///(\ref active_nodemaps, \ref active_edgemaps). If it is there at a certain property,
271 ///it emits a signal with the property, where the gotten mapname was found. One signal
272 ///is emitted for each property displaying the given map.
273 ///\param itisedge whether the map an edgemap or nodemap
274 ///\param mapname name of map to visualize
275 void mapChanged(bool itisedge, std::string mapname);
277 ///Read datas from the given filename.
278 int readFromFile(const std::string &);
280 ///Save datas to the given filename.
281 void writeToFile(const std::string &);
283 ///Deletes all datastructures stored here.
286 void ArrowPosReadOK();
288 void get_design_data(double &, double &, int &);
289 void set_attraction(double);
290 void set_propulsation(double);
291 void set_iteration(int);
293 void redesign_data_changed();
296 #endif //MAPSTORAGE_H