ForSyDe::XMLExport Class Reference

Abstract class used to Export a system as an XML file. More...

#include <xml.hpp>

Public Member Functions

 XMLExport (std::string path)
 The constructor takes the gneration path.
 
 ~XMLExport ()
 The destructor makes sure all XML nodes are deallocated.
 
void traverse (sc_module *top)
 The traverse function requires the top ForSyDe process name. More...
 
xml_nodeinit (const sc_module *p)
 The init member initiates the XML DOM and performs initial settings.
 
void printXML (std::string fileName)
 The print method writes the XML file to the output. More...
 
void add_leaf_process (const ForSyDe::process *p, xml_node<> *pn_node)
 Add a leaf process.
 
void add_leaf_process_ports (const ForSyDe::process *p, xml_node<> *pn_node)
 Add the ports for a leaf process.
 
void add_composite_process (const sc_module *p, xml_node<> *pn_node)
 Add a composite process.
 
void add_port (introspective_port *port, const char *dir, xml_node<> *pn_node, const char *bound_process=NULL, const char *bound_port=NULL)
 Add a port.
 
void add_signal (introspective_channel *sig, xml_node<> *pn_node)
 Add a ForSyDe signal.
 
bool is_leaf (sc_object *module)
 Check if the systemC object is a leaf process.
 
bool is_module (const sc_object *module)
 Check if the systemC object is module.
 
bool is_port (sc_object *port)
 Check if the systemC object is port.
 
bool is_signal (const sc_object *sig)
 Check if the systemC object is a ForSyDe signal.
 

Detailed Description

Abstract class used to Export a system as an XML file.

This class provides basic facilities to export a ForSyDe-SystemC process network as an XML file.

Member Function Documentation

void ForSyDe::XMLExport::printXML ( std::string  fileName)
inline

The print method writes the XML file to the output.

The XML structure is already generated, so this command only checks for the availability of the output file and dumps the XML to it.

void ForSyDe::XMLExport::traverse ( sc_module *  top)
inline

The traverse function requires the top ForSyDe process name.

It initiates the translation job which is a recursive traversal of the process network.


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