COIN-OR::LEMON - Graph Library

Changeset 1440:3d2e3cfb2a6c in lemon-0.x for gui/mapstorage.h


Ignore:
Timestamp:
05/27/05 12:34:20 (15 years ago)
Author:
Hegyi Péter
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1915
Message:

Small documentation is added to GUI

File:
1 edited

Legend:

Unmodified
Added
Removed
  • gui/mapstorage.h

    r1435 r1440  
    66#include <all_include.h>
    77
     8///Class MapStorage is responsible for storing
     9///NodeMaps and EdgeMaps that can be shown later
     10///on GUI. Therefore maps can be added to it,
     11///and datas over the added maps can be queried.
     12///The maps will be stored in an std::map,
     13///referenced with their names. Unfortunately at
     14///the moment it works only with double type maps
     15///
     16///\todo too many things are public!!
    817class MapStorage
    918{
     19public:
    1020
    11 public: ///!!!!!!!!
    1221  Graph g;
     22
     23  ///Stores double type NodeMaps
    1324  std::map< std::string,Graph::NodeMap<double> * > nodemap_storage;
     25
     26  ///Stores double type EdgeMaps
    1427  std::map< std::string,Graph::EdgeMap<double> * > edgemap_storage;
    1528
     29  //Stores the default values for the different visualization node attributes
    1630  std::vector<Graph::NodeMap<double> > default_nodemaps;
     31
     32  //Stores the default values for the different visualization edge attributes
    1733  std::vector<Graph::EdgeMap<double> > default_edgemaps;
    1834
    1935public:
     36  ///Constructor of MapStorage. Expects the Graph of
     37  ///which maps will be stored in it.
     38  ///Its all activity is initializing default values
     39  ///for different visualization attributes
     40  ///
     41  ///\param graph is the graph for which the maps are stored in this object.
    2042  MapStorage(Graph &);
     43
     44  ///Adds given map to storage. A name and the map itself has to be provided.
     45  ///\param name is the name of map
     46  ///\nodemap is the pointer of the given nodemap
     47  ///\todo map should be given by reference!
    2148  int addNodeMap(const std::string &,Graph::NodeMap<double> *);
     49
     50  ///Adds given map to storage. A name and the map itself has to be provided.
     51  ///\param name is the name of map
     52  ///\edgemap is the pointer of the given edgemap
     53  ///\todo map should be given by reference!
    2254  int addEdgeMap(const std::string &,Graph::EdgeMap<double> *);
    2355
     56  ///Returns how much nodemaps is stored in \ref MapStorage
    2457  int numOfNodeMaps() {return nodemap_storage.size();};
     58
     59  ///Returns how much edgemaps is stored in \ref MapStorage
    2560  int numOfEdgeMaps() {return edgemap_storage.size();};
    2661
     62  ///Returns the maximum value of the given NodeMap. NodeMap has to be given by its name.
     63  ///\param name is the name of map of which maximum is searched
    2764  double maxOfNodeMap(const std::string &);
     65
     66  ///Returns the maximum value of the given EdgeMap. EdgeMap has to be given by its name.
     67  ///\param name is the name of map of which maximum is searched
    2868  double maxOfEdgeMap(const std::string &);
    2969
     70  ///Returns the minimum value of the given NodeMap. NodeMap has to be given by its name.
     71  ///\param name is the name of map of which minimum is searched
    3072  double minOfNodeMap(const std::string &);
     73
     74  ///Returns the minimum value of the given EdgeMap. EdgeMap has to be given by its name.
     75  ///\param name is the name of map of which minimum is searched
    3176  double minOfEdgeMap(const std::string &);
    3277
     78  ///To be able to iterate through each maps this function returns an iterator pointing to the first nodemap in the storage.
    3379  std::map< std::string,Graph::NodeMap<double> * >::iterator beginOfNodeMaps(){return nodemap_storage.begin();};
     80
     81  ///To be able to iterate through each maps this function returns an iterator pointing to the first edgemap in the storage.
    3482  std::map< std::string,Graph::EdgeMap<double> * >::iterator beginOfEdgeMaps(){return edgemap_storage.begin();};
    3583};
Note: See TracChangeset for help on using the changeset viewer.