Changeset 1394:f0c48d7fa73d in lemon-0.x for doc

Timestamp:

04/27/05 12:44:58 (20 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Modifying the interface.
add -> read, write

File:

• doc/graph_io.dox (modified) (6 diffs)

doc/graph_io.dox

@@ -90 +90 @@
 \endcode
 
-The \c addNodeMap() function declares a \c NodeMap writing command in the
+The \c writeNodeMap() function declares a \c NodeMap writing 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 
@@ -99 +99 @@
 \code
 IdMap<ListGraph, Node> nodeIdMap;
-writer.addNodeMap("id", nodeIdMap);
-
-writer.addNodeMap("x-coord", xCoordMap);
-writer.addNodeMap("y-coord", yCoordMap);
-writer.addNodeMap("color", colorMap);
-\endcode
-
-With the \c addEdgeMap() member function you can give an edge map
+writer.writeNodeMap("id", nodeIdMap);
+
+writer.writeNodeMap("x-coord", xCoordMap);
+writer.writeNodeMap("y-coord", yCoordMap);
+writer.writeNodeMap("color", colorMap);
+\endcode
+
+With the \c writeEdgeMap() member function you can give an edge map
 writing command similar to the NodeMaps.
 
@@ -112 +112 @@
 \code
 DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > edgeDescMap(graph);
-writer.addEdgeMap("descriptor", edgeDescMap);
-
-writer.addEdgeMap("weight", weightMap);
-writer.addEdgeMap("label", labelMap);
-\endcode
-
-With \c addNode() and \c addEdge() functions you can point out Nodes and
+writer.writeEdgeMap("descriptor", edgeDescMap);
+
+writer.writeEdgeMap("weight", weightMap);
+writer.writeEdgeMap("label", labelMap);
+\endcode
+
+With \c writeNode() and \c writeEdge() functions you can point out Nodes and
 Edges in the graph. By example, you can write out the source and target
 of the graph.
 
 \code
-writer.addNode("source", sourceNode);
-writer.addNode("target", targetNode);
-
-writer.addEdge("observed", edge);
+writer.writeNode("source", sourceNode);
+writer.writeNode("target", targetNode);
+
+writer.writeEdge("observed", edge);
 \endcode
 
@@ -152 +152 @@
 \endcode
 
-The \c addNodeMap() function reads a map from the \c \@nodeset section.
+The \c readNodeMap() function reads a map from the \c \@nodeset section.
 If there is a map that you do not want to read from the file and there is
 whitespace in the string represenation of the values then you should
@@ -159 +159 @@
 \see QuotedStringReader
 \code
-reader.addNodeMap("x-coord", xCoordMap);
-reader.addNodeMap("y-coord", yCoordMap);
-
-reader.addNodeMap<QuotedStringReader>("label", labelMap);
+reader.readNodeMap("x-coord", xCoordMap);
+reader.readNodeMap("y-coord", yCoordMap);
+
+reader.readNodeMap<QuotedStringReader>("label", labelMap);
 reader.skipNodeMap<QuotedStringReader>("description");
 
-reader.addNodeMap("color", colorMap);
-\endcode
-
-With the \c addEdgeMap() member function you can give an edge map
+reader.readNodeMap("color", colorMap);
+\endcode
+
+With the \c readEdgeMap() member function you can give an edge map
 reading command similar to the NodeMaps. 
 
 \code
-reader.addEdgeMap("weight", weightMap);
-reader.addEdgeMap("label", labelMap);
-\endcode
-
-With \c addNode() and \c addEdge() functions you can read labeled Nodes and
+reader.readEdgeMap("weight", weightMap);
+reader.readEdgeMap("label", labelMap);
+\endcode
+
+With \c readNode() and \c readEdge() functions you can read labeled Nodes and
 Edges.
 
 \code
-reader.addNode("source", sourceNode);
-reader.addNode("target", targetNode);
-
-reader.addEdge("observed", edge);
+reader.readNode("source", sourceNode);
+reader.readNode("target", targetNode);
+
+reader.readEdge("observed", edge);
 \endcode
 
@@ -231 +231 @@
 };
 ...
-reader.addNodeMap<LengthReader>("strings", lengthMap);
+reader.readNodeMap<LengthReader>("strings", lengthMap);
 \endcode