Changeset 1901:723b2b81d900 in lemon-0.x for lemon/graph_writer.h

Timestamp:

01/24/06 17:07:38 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Lemon Graph Format uses label instead of id named map.

File:

• lemon/graph_writer.h (modified) (4 diffs)

lemon/graph_writer.h

@@ -55 +55 @@
   /// command in the \c GraphWriter. You should give as parameter 
   /// the name of the map and the map object. The NodeMap writing 
-  /// command with name "id" should write a unique map because it 
-  /// is regarded as ID map (such a map is essential if the graph has edges).
-  ///
-  /// \code
-  /// IdMap<ListGraph, Node> nodeIdMap;
-  /// writer.writeNodeMap("id", nodeIdMap);
+  /// command with name "label" should write a unique map because it 
+  /// is regarded as label map (such a map is essential if the graph has edges).
+  ///
+  /// \code
+  /// IdMap<ListGraph, Node> nodeLabelMap;
+  /// writer.writeNodeMap("label", nodeLabelMap);
   ///
   /// writer.writeNodeMap("coords", coords);
@@ -254 +254 @@
     }
 
-    /// \brief Write the id of the given node.
-    ///
-    /// It writes the id of the given node. If there was written an "id"
+    /// \brief Write the label of the given node.
+    ///
+    /// It writes the label of the given node. If there was written an "label"
     /// named node map then it will write the map value belonging to the node.
-    void writeId(std::ostream& os, const Node& item) const {
-      nodeset_writer.writeId(os, item);
+    void writeLabel(std::ostream& os, const Node& item) const {
+      nodeset_writer.writeLabel(os, item);
     } 
 
-    /// \brief Write the id of the given edge.
-    ///
-    /// It writes the id of the given edge. If there was written an "id"
+    /// \brief Write the label of the given edge.
+    ///
+    /// It writes the label of the given edge. If there was written an "label"
     /// named edge map then it will write the map value belonging to the edge.
-    void writeId(std::ostream& os, const Edge& item) const {
-      edgeset_writer.writeId(os, item);
+    void writeLabel(std::ostream& os, const Edge& item) const {
+      edgeset_writer.writeLabel(os, item);
     } 
 
@@ -328 +328 @@
   /// command in the \c UndirGraphWriter. You should give as parameter 
   /// the name of the map and the map object. The NodeMap writing 
-  /// command with name "id" should write a unique map because it 
-  /// is regarded as ID map.
-  ///
-  /// \code
-  /// IdMap<UndirListGraph, Node> nodeIdMap;
-  /// writer.writeNodeMap("id", nodeIdMap);
+  /// command with name "label" should write a unique map because it 
+  /// is regarded as label map.
+  ///
+  /// \code
+  /// IdMap<UndirListGraph, Node> nodeLabelMap;
+  /// writer.writeNodeMap("label", nodeLabelMap);
   ///
   /// writer.writeNodeMap("coords", coords);
@@ -562 +562 @@
     }
 
-    /// \brief Write the id of the given node.
-    ///
-    /// It writes the id of the given node. If there was written an "id"
+    /// \brief Write the label of the given node.
+    ///
+    /// It writes the label of the given node. If there was written an "label"
     /// named node map then it will write the map value belonging to the node.
-    void writeId(std::ostream& os, const Node& item) const {
-      nodeset_writer.writeId(os, item);
+    void writeLabel(std::ostream& os, const Node& item) const {
+      nodeset_writer.writeLabel(os, item);
     } 
 
-    /// \brief Write the id of the given edge.
-    ///
-    /// It writes the id of the given edge. If there was written an "id"
+    /// \brief Write the label of the given edge.
+    ///
+    /// It writes the label of the given edge. If there was written an "label"
     /// named edge map then it will write the map value belonging to the edge.
-    void writeId(std::ostream& os, const Edge& item) const {
-      undir_edgeset_writer.writeId(os, item);
+    void writeLabel(std::ostream& os, const Edge& item) const {
+      undir_edgeset_writer.writeLabel(os, item);
     } 
 
-    /// \brief Write the id of the given undirected edge.
-    ///
-    /// It writes the id of the given undirected edge. If there was written 
-    /// an "id" named edge map then it will write the map value belonging to 
+    /// \brief Write the label of the given undirected edge.
+    ///
+    /// It writes the label of the given undirected edge. If there was written 
+    /// an "label" named edge map then it will write the map value belonging to 
     /// the edge.
-    void writeId(std::ostream& os, const UndirEdge& item) const {
-      undir_edgeset_writer.writeId(os, item);
+    void writeLabel(std::ostream& os, const UndirEdge& item) const {
+      undir_edgeset_writer.writeLabel(os, item);
     }