Exporter from a generic netlist into structural verilog. More...

#include <VerilogExporter.hpp>

Public Member Functions
	VerilogExporter (RootSharedPtr inRootPtr)
	Public constructor. More...

bool	operator() (const boost::filesystem::path &inFilename)
	Export Verilog to a file. More...

bool	operator() (std::ostream &inOutputStream=std::cout)
	Export Verilog to an output stream. More...

Protected Types
typedef std::string	string
	Imported type name. More...

Protected Attributes
RootSharedPtr	mRootPtr
	Root of the generic netlist. More...

Friends
class	torc::generic::generic::VerilogExporterUnitTest
	The unit test class has access to our internals. More...

Detailed Description

Exporter from a generic netlist into structural verilog.

Definition at line 33 of file VerilogExporter.hpp.

Member Typedef Documentation

typedef std::string torc::generic::VerilogExporter::string

protected

Imported type name.

Definition at line 40 of file VerilogExporter.hpp.

Constructor & Destructor Documentation

torc::generic::VerilogExporter::VerilogExporter ( RootSharedPtr inRootPtr )

Public constructor.

Definition at line 31 of file VerilogExporter.cpp.

31 : mRootPtr(inRootPtr) {}

torc::generic::VerilogExporter::mRootPtr

RootSharedPtr mRootPtr

Root of the generic netlist.

Definition: VerilogExporter.hpp:43

Member Function Documentation

bool torc::generic::VerilogExporter::operator() ( const boost::filesystem::path & inFilename )

Export Verilog to a file.

Parameters

inFilename Output file name.

Returns: true if successfully exported.

Definition at line 33 of file VerilogExporter.cpp.

                                                                     {
 
         // prepare the output stream
         string outFileName = path.string();
         fstream verilogExport(outFileName.c_str(), ios_base::out);
         return (*this)(verilogExport);
     }

bool torc::generic::VerilogExporter::operator() ( std::ostream & inOutputStream = std::cout )

Export Verilog to an output stream.

Parameters

inOutputStream.

Returns: true if successfully exported.

Definition at line 41 of file VerilogExporter.cpp.

                                                                {
 
         // export the Verilog code
         torc::generic::VerilogExporterVisitor verilogExporterVisitor(mRootPtr, inOutputStream);
         try {
             mRootPtr->accept(verilogExporterVisitor);
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
 
         return true; //mSuccess;
     }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class torc::generic::generic::VerilogExporterUnitTest

friend

The unit test class has access to our internals.

Definition at line 37 of file VerilogExporter.hpp.

Field Documentation

RootSharedPtr torc::generic::VerilogExporter::mRootPtr

protected

Root of the generic netlist.

Definition at line 43 of file VerilogExporter.hpp.

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

Public Member Functions

Protected Types