Changeset 1133:9fd485470fee in lemon-0.x for src/work/deba/graph_writer.h

Timestamp:

02/07/05 11:48:14 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1532

Message:

Documentation

File:

• src/work/deba/graph_writer.h (modified) (7 diffs)

src/work/deba/graph_writer.h

@@ -34 +34 @@
 namespace lemon {
 
+  /// \brief Standard WriterTraits for the GraphWriter class.
+  ///
+  /// Standard WriterTraits for the GraphWriter class.
+  /// It defines standard writing method for all type of value. 
   struct DefaultWriterTraits {
 
+    /// \brief Template class for writing an value.
+    ///
+    /// Template class for writing an value.
     template <typename _Value>
     struct Writer {
+      /// The value type.
       typedef _Value Value;
 
+      /// \brief Writes a value from the given stream.
+      ///
+      /// Writes a value from the given stream.
       void write(std::ostream& os, const Value& value) {
         os << value << '\t';
@@ -48 +59 @@
 
 
+  /// \brief Writer class for quoted strings.
+  ///
+  /// Writer class for quoted strings. It can process the escape
+  /// sequences in the string.
   class QuotedStringWriter {
   public:
     typedef std::string Value;
 
+    /// \brief Constructor for the writer.
+    ///
+    /// Constructor for the writer. If the given parameter is true
+    /// the writer creates escape sequences from special characters.
     QuotedStringWriter(bool _escaped = true) : escaped(_escaped) {}
 
+    /// \brief Writes a quoted string from the given stream.
+    ///
+    /// Writes a quoted string from the given stream.
     void write(std::ostream& os, const std::string& value) {
       os << "\"";
@@ -118 +140 @@
   };
 
-  // Graph writer
   
+  /// \brief The graph writer class.
+  ///
+  /// The writer class for the graph output.
+  /// \see graph-io-page
   template <typename _Graph, typename _WriterTraits = DefaultWriterTraits> 
   class GraphWriter {
@@ -131 +156 @@
 
     typedef _WriterTraits WriterTraits;
-
+ 
+    /// \brief Construct a new GraphWriter.
+    ///
+    /// Construct a new GraphWriter. It writes from the given map,
+    /// it constructs the given map and it use the given writer as the
+    /// default skipper.
     GraphWriter(std::ostream& _os, Graph& _graph) : os(_os), graph(_graph) {}
 
 
+    /// \brief Destruct the graph writer.
+    ///
+    /// Destruct the graph writer.
     ~GraphWriter() {
       for (typename NodeMapWriters::iterator it = node_map_writers.begin(); 
@@ -150 +183 @@
     // Node map rules
 
+    /// \brief Add a new node map writer command for the writer.
+    ///
+    /// Add a new node map writer command for the writer.
     template <typename Map>
     GraphWriter& addNodeMap(std::string name, const Map& map) {
@@ -156 +192 @@
     }
 
+    /// \brief Add a new node map writer command for the writer.
+    ///
+    /// Add a new node map writer command for the writer.
     template <typename Writer, typename Map>
     GraphWriter& addNodeMap(std::string name, const Map& map, 
                               const Writer& writer = Writer()) {
-      //      if (node_map_writers.find(name) != node_map_writers.end()) {
-      //        throw Exception() << "Multiple write rule for node map: " 
-      //        << name;
-      //      }
       node_map_writers.push_back(
         make_pair(name, new MapWriter<Node, Map, Writer>(map, writer)));
@@ -170 +205 @@
     // Edge map rules
 
+    /// \brief Add a new edge map writer command for the writer.
+    ///
+    /// Add a new edge map writer command for the writer.
     template <typename Map>
     GraphWriter& addEdgeMap(std::string name, const Map& map) { 
-      return addEdgeMap<typename WriterTraits::template Writer<typename Map::Value>, Map>(name, map);
-    }
-
-
+      return addEdgeMap<typename WriterTraits::template Writer<
+        typename Map::Value>, Map>(name, map);
+    }
+
+
+    /// \brief Add a new edge map writer command for the writer.
+    ///
+    /// Add a new edge map writer command for the writer.
     template <typename Writer, typename Map>
-    GraphWriter& addEdgeMap(std::string name, const Map& map, const Writer& writer = Writer()) {
-      //      if (edge_map_writers.find(name) != edge_map_writers.end()) {
-      //        throw Exception() << "Multiple write rule for edge map: " << name;
-      //      }
-      edge_map_writers.push_back(make_pair(name, new MapWriter<Edge, Map, Writer>(map, writer)));
+    GraphWriter& addEdgeMap(std::string name, 
+                            const Map& map, const Writer& writer = Writer()) {
+      edge_map_writers.push_back(make_pair(name, 
+        new MapWriter<Edge, Map, Writer>(map, writer)));
       return *this;
     }
 
-    // Node rules
+    /// \brief Add a new labeled node writer for the writer.
+    ///
+    /// Add a new labeled node writer for the writer.
     GraphWriter& addNode(std::string name, const Node& node) {
-      //      if (node_writers.find(name) != node_writers.end()) {
-      //        throw Exception() << "Multiple write rule for node";
-      //      }
       node_writers.push_back(make_pair(name, node));
       return *this;
     }
 
-    // Edge rules
-
+    /// \brief Add a new labeled edge writer for the writer.
+    ///
+    /// Add a new labeled edge writer for the writer.
     GraphWriter& addEdge(std::string name, const Edge& edge) {
-      //      if (edge_writers.find(name) != edge_writers.end()) {
-      //        throw Exception() << "Multiple write rule for edge";
-      //      }
       edge_writers.push_back(make_pair(name, edge));
       return *this;
     }
 
-    void write() {   
+    /// \brief Executes the writer commands.
+    ///
+    /// Executes the writer commands.
+    void run() {   
       writeNodeSet();
       writeEdgeSet();