UnCoVer (Using Coverability for Verification)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GTXLWriter Class Referenceabstract

This class exports GXL or GTXL XML files by converting them from Hypergraph and GTS objects respectively. More...

#include <GTXLWriter.h>

Inheritance diagram for GTXLWriter:
Inheritance graph
[legend]

Public Member Functions

virtual ~GTXLWriter ()
 Destroys the GTXLWriter object.
 
virtual void writeGXL (vector< graphs::Hypergraph_sp > const &graphs, string filename) const
 This method takes a collection of Hypergraphs and stores the collection as a GXL XML-file with the given filename. More...
 
virtual void writeGXL (vector< graphs::Hypergraph_sp > const &graphs, boost::filesystem::path &filename) const =0
 This method takes a collection of Hypergraphs and stores the collection as a GXL XML-file with the given filename. More...
 
virtual void writeGXL (graphs::Hypergraph_sp graph, string filename) const
 This method takes a single Hypergraph and stores it as a GXL XML-file with the given filename. More...
 
virtual void writeGXL (graphs::Hypergraph_sp graph, boost::filesystem::path &filename) const
 This method takes a single Hypergraph and stores it as a GXL XML-file with the given filename. More...
 
virtual void writeGTXL (graphs::GTS const &gts, string filename) const
 This method takes a GTS object and stores it as a GTXL XML-file with the given filename. More...
 
virtual void writeGTXL (graphs::GTS const &gts, boost::filesystem::path &filename) const =0
 This method takes a GTS object and stores it as a GTXL XML-file with the given filename. More...
 
void setGraphIDStorage (bool value)
 Sets whether the graph IDs used internally will be stored in the resulting file. More...
 
bool getGraphIDStorage () const
 Returns whether internal graph IDs will be exported. More...
 
void setRuleIDStorage (bool value)
 Sets whether internal rule IDs should be stores in the resulting file. More...
 
bool getRuleIDStorage () const
 Returns whether internal rule IDs will be exported. More...
 

Static Public Member Functions

static GTXLWriternewWriter ()
 Use this method to generate a new GTXLWriter object. More...
 
static unique_ptr< GTXLWriternewUniqueWriter ()
 Use this method to generate a new GTXLWriter object. More...
 

Protected Member Functions

 GTXLWriter ()
 The default constructor is hidden.
 

Protected Attributes

bool storeGraphIDs
 A value of true will cause the internally used ID of a graph to be stored as its name in the exported file.
 
bool storeRuleIDs
 A value of true will cause the internally used ID of a rule to be stored as its name in the exported file.
 

Detailed Description

This class exports GXL or GTXL XML files by converting them from Hypergraph and GTS objects respectively.

Author
Jan Stückrath

Member Function Documentation

bool getGraphIDStorage ( ) const

Returns whether internal graph IDs will be exported.

Returns
true, iff internal graph IDs will exported
bool getRuleIDStorage ( ) const

Returns whether internal rule IDs will be exported.

Returns
ture, iff internal rule IDs will be exported
unique_ptr< GTXLWriter > newUniqueWriter ( )
static

Use this method to generate a new GTXLWriter object.

No initialization is needed before use.

Returns
a pointer to a new GTXLWriter object
GTXLWriter * newWriter ( )
static

Use this method to generate a new GTXLWriter object.

No initialization is needed before use.

Warning
The caller has to properly delete the GTXLWriter after use to avoid memory leaks.
Returns
a pointer to a new GTXLWriter object
void setGraphIDStorage ( bool  value)

Sets whether the graph IDs used internally will be stored in the resulting file.

Parameters
valueuse 'true' if the graph IDs will be stored
void setRuleIDStorage ( bool  value)

Sets whether internal rule IDs should be stores in the resulting file.

Parameters
valueuse 'true if the rule IDs should be stored
void writeGTXL ( graphs::GTS const &  gts,
string  filename 
) const
virtual

This method takes a GTS object and stores it as a GTXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
gtsthe GTS object to be stored
filenamethe filename of the resulting GTXL file
virtual void writeGTXL ( graphs::GTS const &  gts,
boost::filesystem::path &  filename 
) const
pure virtual

This method takes a GTS object and stores it as a GTXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
gtsthe GTS object to be stored
filenamethe filename of the resulting GTXL file

Implemented in GTXLWriterXerces.

void writeGXL ( vector< graphs::Hypergraph_sp > const &  graphs,
string  filename 
) const
virtual

This method takes a collection of Hypergraphs and stores the collection as a GXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
graphsa pointer to a vector of Hypergraphs to be stored
filenamethe filename of the resulting GXL file
virtual void writeGXL ( vector< graphs::Hypergraph_sp > const &  graphs,
boost::filesystem::path &  filename 
) const
pure virtual

This method takes a collection of Hypergraphs and stores the collection as a GXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
graphsa pointer to a vector of Hypergraphs to be stored
filenamethe filename of the resulting GXL file

Implemented in GTXLWriterXerces.

void writeGXL ( graphs::Hypergraph_sp  graph,
string  filename 
) const
virtual

This method takes a single Hypergraph and stores it as a GXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
grapha pointer to the Hypergraph to be stored
filenamethe filename of the resulting GXL file
virtual void writeGXL ( graphs::Hypergraph_sp  graph,
boost::filesystem::path &  filename 
) const
virtual

This method takes a single Hypergraph and stores it as a GXL XML-file with the given filename.

If the file already exists, it is overwritten (if possible).

Parameters
grapha pointer to the Hypergraph to be stored
filenamethe filename of the resulting GXL file

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