OpenFPM_io  0.2.0
Project that contain the implementation and interfaces for basic structure like vectors, grids, graph ... .
 All Data Structures Functions Variables Typedefs
GraphMLWriter< Graph > Class Template Reference

#include <GraphMLWriter.hpp>

Public Member Functions

 GraphMLWriter (Graph &g)
 
bool write (std::string file, std::string graph_name="Graph")
 It write a GraphML file from a graph. More...
 

Private Member Functions

std::string get_vertex_properties_list ()
 It get the vertex properties list. More...
 
std::string get_edge_properties_list ()
 It get the edge properties list. More...
 
std::string get_vertex_list ()
 
std::string get_edge_list ()
 

Private Attributes

Graph & g
 

Detailed Description

template<typename Graph>
class GraphMLWriter< Graph >

From a Graphbasic structure it write a GraphML format file

Definition at line 491 of file GraphMLWriter.hpp.

Constructor & Destructor Documentation

template<typename Graph>
GraphMLWriter< Graph >::GraphMLWriter ( Graph &  g)
inline

GraphMLWriter constructor, it take a graph and write a GraphML format

Parameters
gGraph to write

Definition at line 627 of file GraphMLWriter.hpp.

Member Function Documentation

template<typename Graph>
std::string GraphMLWriter< Graph >::get_edge_list ( )
inlineprivate

edge node output string

Get an edge iterator

Definition at line 580 of file GraphMLWriter.hpp.

template<typename Graph>
std::string GraphMLWriter< Graph >::get_edge_properties_list ( )
inlineprivate

It get the edge properties list.

It get the edge properties list of the edge defined as a GraphML header

Returns
a string that define the edge properties in graphML format

edge property output string

Definition at line 528 of file GraphMLWriter.hpp.

template<typename Graph>
std::string GraphMLWriter< Graph >::get_vertex_list ( )
inlineprivate

vertex node output string

Get a vertex iterator

Definition at line 543 of file GraphMLWriter.hpp.

template<typename Graph>
std::string GraphMLWriter< Graph >::get_vertex_properties_list ( )
inlineprivate

It get the vertex properties list.

It get the vertex properties list of the vertex defined as a GraphML header and define position and shape of the node

Returns
a string that define the vertex properties in graphML format

vertex property output string

Definition at line 505 of file GraphMLWriter.hpp.

template<typename Graph>
bool GraphMLWriter< Graph >::write ( std::string  file,
std::string  graph_name = "Graph" 
)
inline

It write a GraphML file from a graph.

Parameters
filepath where to write
nameof the graph

Definition at line 638 of file GraphMLWriter.hpp.


The documentation for this class was generated from the following file: