diff -r 2edd8cd06eaf -r f0c48d7fa73d doc/graph_io.dox --- a/doc/graph_io.dox Wed Apr 27 10:42:58 2005 +0000 +++ b/doc/graph_io.dox Wed Apr 27 10:44:58 2005 +0000 @@ -89,7 +89,7 @@ GraphWriter writer(std::cout, graph); \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 unique map because it is regarded as ID map. @@ -98,34 +98,34 @@ \code IdMap nodeIdMap; -writer.addNodeMap("id", nodeIdMap); +writer.writeNodeMap("id", nodeIdMap); -writer.addNodeMap("x-coord", xCoordMap); -writer.addNodeMap("y-coord", yCoordMap); -writer.addNodeMap("color", colorMap); +writer.writeNodeMap("x-coord", xCoordMap); +writer.writeNodeMap("y-coord", yCoordMap); +writer.writeNodeMap("color", colorMap); \endcode -With the \c addEdgeMap() member function you can give an edge map +With the \c writeEdgeMap() member function you can give an edge map writing command similar to the NodeMaps. \see IdMap, DescriptorMap \code DescriptorMap > edgeDescMap(graph); -writer.addEdgeMap("descriptor", edgeDescMap); +writer.writeEdgeMap("descriptor", edgeDescMap); -writer.addEdgeMap("weight", weightMap); -writer.addEdgeMap("label", labelMap); +writer.writeEdgeMap("weight", weightMap); +writer.writeEdgeMap("label", labelMap); \endcode -With \c addNode() and \c addEdge() functions you can point out Nodes and +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.writeNode("source", sourceNode); +writer.writeNode("target", targetNode); -writer.addEdge("observed", edge); +writer.writeEdge("observed", edge); \endcode After you give all write commands you must call the \c run() member @@ -151,38 +151,38 @@ GraphReader reader(std::cin, graph); \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 call the \c skipNodeMap() template member function with proper parameters. \see QuotedStringReader \code -reader.addNodeMap("x-coord", xCoordMap); -reader.addNodeMap("y-coord", yCoordMap); +reader.readNodeMap("x-coord", xCoordMap); +reader.readNodeMap("y-coord", yCoordMap); -reader.addNodeMap("label", labelMap); +reader.readNodeMap("label", labelMap); reader.skipNodeMap("description"); -reader.addNodeMap("color", colorMap); +reader.readNodeMap("color", colorMap); \endcode -With the \c addEdgeMap() member function you can give an edge map +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); +reader.readEdgeMap("weight", weightMap); +reader.readEdgeMap("label", labelMap); \endcode -With \c addNode() and \c addEdge() functions you can read labeled Nodes and +With \c readNode() and \c readEdge() functions you can read labeled Nodes and Edges. \code -reader.addNode("source", sourceNode); -reader.addNode("target", targetNode); +reader.readNode("source", sourceNode); +reader.readNode("target", targetNode); -reader.addEdge("observed", edge); +reader.readEdge("observed", edge); \endcode After you give all read commands you must call the \c run() member @@ -230,7 +230,7 @@ } }; ... -reader.addNodeMap("strings", lengthMap); +reader.readNodeMap("strings", lengthMap); \endcode The global functionality of the reader class can be changed by giving a