torc::physical::XdlImporter Class Reference
Importer from XDL format into a physical design. More...
#include <XdlImporter.hpp>
Public Member Functions | |
| XdlImporter (void) | |
| Construct the parser importer context. | |
| virtual | ~XdlImporter (void) |
| Virtual destructor. | |
| DEPRECATED bool | import (istream &in, const string &name="stream input") |
| Import XDL from an input stream. | |
| bool | operator() (istream &in, const string &name="stream input") |
| Import XDL from an input stream. | |
| DEPRECATED bool | import (const string &input, const string &name="string stream") |
| Import XDL from a string. | |
| bool | operator() (const string &input, const string &name="string stream") |
| Import XDL from a string. | |
| DEPRECATED bool | import (const boost::filesystem::path &filename) |
| Import XDL from a file. | |
| bool | operator() (const boost::filesystem::path &filename) |
| Import XDL from a file. | |
| void | error (const location &l, const string &m) |
| Error handling with associated line number. | |
| void | error (const string &m) |
| General error handling. | |
| void | failure (void) |
| Signals a parsing failure by deasserting the success flag. | |
| DesignSharedPtr | getDesignPtr (void) |
| Returns a shared pointer for the design. | |
Public Attributes | |
| bool | mTraceScanning |
| Enable debug output in the flex scanner. | |
| bool | mTraceParsing |
| Enable debug output in the bison parser. | |
| string | mStreamName |
| Name of file or input stream for error messages. | |
| class torc::XdlScanner * | lexer |
| Pointer to the current lexer instance. | |
Protected Types | |
| enum | EPipType { ePipTypeRegular = 0, ePipTypeRoutethrough } |
| The pip type, either regular or routethrough. More... | |
Protected Member Functions | |
| virtual void | initializeDatabase (void) |
| Initialize the database if applicable. | |
| virtual void | bind (torc::physical::InstancePinSharedPtr &) |
| Bind the given instance pin to its database Tilewire if applicable. | |
| virtual void | bind (torc::physical::Pip &, EPipType) |
| Bind the given pip to the database arc and wire usage if applicable. | |
Protected Attributes | |
| bool | mSuccess |
| Flag signaling parsing success. | |
| string | mDesignName |
| Name of the design. | |
| string | mDesignPart |
| Device, package, and speed grade specified for the design. | |
| string | mDesignDevice |
| Device specified for the design. | |
| string | mDesignPackage |
| Package specified for the design. | |
| string | mDesignSpeedGrade |
| Speed grade specified for the design. | |
| string | mDesignXdlVersion |
| XDL version read in by the design. | |
| DesignSharedPtr | mDesignPtr |
| Shared pointer to the design. | |
| CircuitWeakPtr | mCircuitPtr |
| Weak pointer to the circuit. | |
| boost::uint32_t | mModuleCount |
| Number of modules read for the design. | |
| string | mModuleName |
| Name of the module. | |
| string | mModuleAnchor |
| Module anchor instance name. | |
| string | mModuleInstance |
| Name of instantiating instance for module reference. | |
| ModuleSharedPtr | mModulePtr |
| Shared pointer to the current module. | |
| string | mReferenceInstantiation |
| Name under which the module was instantiated. | |
| string | mReferenceModule |
| Name of the referenced module. | |
| string | mReferenceInstance |
| Name of the referenced instance. | |
| ModuleSharedPtr | mReferenceModulePtr |
| Shared pointer to the referenced module. | |
| InstanceSharedPtr | mReferenceInstancePtr |
| Shared pointer to the referenced instance. | |
| InstanceReferenceSharedPtr | mInstanceReferencePtr |
| Shared pointer to instance reference. | |
| string | mPortName |
| Name of the port. | |
| string | mPortInstance |
| Current port instance name. | |
| string | mPortPin |
| Current port pin name. | |
| PortTempVector | mPortTempVector |
| Vector of ports not yet mapped to instances. | |
| boost::uint32_t | mInstanceCount |
| Number of instances read for the design. | |
| string | mInstanceName |
| Current instance name. | |
| TileTypeName | mInstanceType |
| Current instance type. | |
| SiteName | mInstanceSite |
| Current instance site name. | |
| TileName | mInstanceTile |
| Current instance tile name. | |
| torc::physical::EInstanceBonding | mInstanceBonding |
| Current instance bonding. | |
| InstanceSharedPtr | mInstancePtr |
| Shared pointer to the current instance. | |
| boost::uint32_t | mNetCount |
| Number of nets read for the design. | |
| torc::physical::ENetType | mNetType |
| Current net type. | |
| string | mNetName |
| Current net name. | |
| NetSharedPtr | mNetPtr |
| Shared pointer to the current net. | |
| InstanceName | mPinInstance |
| Current pin instance name. | |
| PinName | mPinName |
| Current pin name. | |
| torc::physical::EPinDirection | mPinDirection |
| Current pin direction. | |
| TileName | mPipTile |
| Current pip tile name. | |
| WireName | mPipSource |
| Current pip source wire name. | |
| WireName | mPipSink |
| Current pip sink wire name. | |
| torc::physical::EPipDirection | mPipDirection |
| Current pip directionality. | |
| string | mRoutethroughConfigSetting |
| Current routethrough config setting. | |
| string | mRoutethroughConfigName |
| Current routethrough config name. | |
| string | mRoutethroughConfigValue |
| Current routethrough config value. | |
| string | mRoutethroughInstance |
| Current routethrough Instance name. | |
| WireName | mRoutethroughSource |
| Current routethrough source wire name. | |
| WireName | mRoutethroughSink |
| Current routethrough sink wire name. | |
| boost::uint32_t | mConfigCount |
| Number of configurations read for the design. | |
| ConfigMap | mConfigMap |
| Current config map. | |
| string | mConfigSetting |
| Current config setting. | |
| string | mConfigName |
| Current config name. | |
| string | mConfigValue |
| Current config value. | |
Private Types | |
| typedef std::string | string |
| Imported type name. | |
| typedef std::istream | istream |
| Imported type name. | |
Friends | |
| class | torc::physical::physical::XdlImporterUnitTest |
| The unit test class has access to our internals. | |
| class | torc::XdlParser |
| The XdlParse has access to our members. | |
Detailed Description
Importer from XDL format into a physical design.The XdlImporter creates the XdlParser and XdlScanner classes and connects them. The input stream is then fed into the scanner object, which delivers a sequence of tokens to the parser. The importer is also available as a parameter to the grammar rules.
Definition at line 48 of file XdlImporter.hpp.
Member Typedef Documentation
typedef std::string torc::physical::XdlImporter::string [private] |
typedef std::istream torc::physical::XdlImporter::istream [private] |
Member Enumeration Documentation
enum torc::physical::XdlImporter::EPipType [protected] |
Constructor & Destructor Documentation
| torc::physical::XdlImporter::XdlImporter | ( | void | ) |
Construct the parser importer context.
Reimplemented in torc::architecture::XdlImporter.
Definition at line 30 of file XdlImporter.cpp.
| virtual torc::physical::XdlImporter::~XdlImporter | ( | void | ) | [inline, virtual] |
Virtual destructor.
Reimplemented in torc::architecture::XdlImporter.
Definition at line 65 of file XdlImporter.hpp.
Member Function Documentation
| DEPRECATED bool torc::physical::XdlImporter::import | ( | istream & | in, | |
| const string & | name = "stream input" | |||
| ) | [inline] |
Import XDL from an input stream.
- Parameters:
-
in Input stream. name Stream name to use for error messages.
- Returns:
- true if successfully parsed.
- Deprecated:
- Please use operator()(...) instead of import(...). i.e. importer(stream, name);
Definition at line 92 of file XdlImporter.hpp.
Import XDL from an input stream.
- Parameters:
-
in Input stream. name Stream name to use for error messages.
- Returns:
- true if successfully parsed.
Definition at line 48 of file XdlImporter.cpp.
| DEPRECATED bool torc::physical::XdlImporter::import | ( | const string & | input, | |
| const string & | name = "string stream" | |||
| ) | [inline] |
Import XDL from a string.
- Parameters:
-
input Input stream. name Stream name to use for error messages.
- Returns:
- true if successfully parsed.
- Deprecated:
- Please use operator()(...) instead of import(...). i.e. importer(input, name);
Definition at line 106 of file XdlImporter.hpp.
| bool torc::physical::XdlImporter::operator() | ( | const string & | input, | |
| const string & | name = "string stream" | |||
| ) |
Import XDL from a string.
- Parameters:
-
input Input stream. name Stream name to use for error messages.
- Returns:
- true if successfully parsed.
Definition at line 68 of file XdlImporter.cpp.
| DEPRECATED bool torc::physical::XdlImporter::import | ( | const boost::filesystem::path & | filename | ) | [inline] |
Import XDL from a file.
- Parameters:
-
filename Input file name.
- Returns:
- true if successfully parsed.
- Deprecated:
- Please use operator()(...) instead of import(...). i.e. importer(filename);
Definition at line 118 of file XdlImporter.hpp.
| bool torc::physical::XdlImporter::operator() | ( | const boost::filesystem::path & | filename | ) |
Import XDL from a file.
- Parameters:
-
filename Input file name.
- Returns:
- true if successfully parsed.
Definition at line 61 of file XdlImporter.cpp.
| void torc::physical::XdlImporter::error | ( | const location & | l, | |
| const string & | m | |||
| ) |
Error handling with associated line number.
This can be modified to output the error in another manner, for example to a dialog box.
Definition at line 73 of file XdlImporter.cpp.
| void torc::physical::XdlImporter::error | ( | const string & | m | ) |
General error handling.
This can be modified to output the error in another manner, for example to a dialog box.
Definition at line 78 of file XdlImporter.cpp.
| void torc::physical::XdlImporter::failure | ( | void | ) | [inline] |
Signals a parsing failure by deasserting the success flag.
Definition at line 138 of file XdlImporter.hpp.
| DesignSharedPtr torc::physical::XdlImporter::getDesignPtr | ( | void | ) | [inline] |
Returns a shared pointer for the design.
This design is created and populated during XDL import process.
Definition at line 143 of file XdlImporter.hpp.
| virtual void torc::physical::XdlImporter::initializeDatabase | ( | void | ) | [inline, protected, virtual] |
Initialize the database if applicable.
Only the torc::architecture::XdlImporter subclass actually initializes the database.
Reimplemented in torc::architecture::XdlImporter.
Definition at line 234 of file XdlImporter.hpp.
| virtual void torc::physical::XdlImporter::bind | ( | torc::physical::InstancePinSharedPtr & | ) | [inline, protected, virtual] |
Bind the given instance pin to its database Tilewire if applicable.
Reimplemented in torc::architecture::XdlImporter.
Definition at line 236 of file XdlImporter.hpp.
| virtual void torc::physical::XdlImporter::bind | ( | torc::physical::Pip & | , | |
| EPipType | ||||
| ) | [inline, protected, virtual] |
Bind the given pip to the database arc and wire usage if applicable.
Reimplemented in torc::architecture::XdlImporter.
Definition at line 238 of file XdlImporter.hpp.
Friends And Related Function Documentation
friend class torc::physical::physical::XdlImporterUnitTest [friend] |
friend class torc::XdlParser [friend] |
Member Data Documentation
| class torc::XdlScanner* torc::physical::XdlImporter::lexer |
Pointer to the current lexer instance.
This serves to connect the parser to the scanner, and is used by the yylex macro.
Definition at line 77 of file XdlImporter.hpp.
bool torc::physical::XdlImporter::mSuccess [protected] |
string torc::physical::XdlImporter::mDesignName [protected] |
string torc::physical::XdlImporter::mDesignPart [protected] |
Device, package, and speed grade specified for the design.
Definition at line 160 of file XdlImporter.hpp.
string torc::physical::XdlImporter::mDesignDevice [protected] |
string torc::physical::XdlImporter::mDesignPackage [protected] |
string torc::physical::XdlImporter::mDesignSpeedGrade [protected] |
string torc::physical::XdlImporter::mDesignXdlVersion [protected] |
boost::uint32_t torc::physical::XdlImporter::mModuleCount [protected] |
string torc::physical::XdlImporter::mModuleName [protected] |
string torc::physical::XdlImporter::mModuleAnchor [protected] |
string torc::physical::XdlImporter::mModuleInstance [protected] |
Name of instantiating instance for module reference.
Definition at line 172 of file XdlImporter.hpp.
string torc::physical::XdlImporter::mReferenceModule [protected] |
string torc::physical::XdlImporter::mPortName [protected] |
string torc::physical::XdlImporter::mPortInstance [protected] |
string torc::physical::XdlImporter::mPortPin [protected] |
boost::uint32_t torc::physical::XdlImporter::mInstanceCount [protected] |
string torc::physical::XdlImporter::mInstanceName [protected] |
SiteName torc::physical::XdlImporter::mInstanceSite [protected] |
TileName torc::physical::XdlImporter::mInstanceTile [protected] |
boost::uint32_t torc::physical::XdlImporter::mNetCount [protected] |
string torc::physical::XdlImporter::mNetName [protected] |
NetSharedPtr torc::physical::XdlImporter::mNetPtr [protected] |
PinName torc::physical::XdlImporter::mPinName [protected] |
TileName torc::physical::XdlImporter::mPipTile [protected] |
WireName torc::physical::XdlImporter::mPipSource [protected] |
WireName torc::physical::XdlImporter::mPipSink [protected] |
boost::uint32_t torc::physical::XdlImporter::mConfigCount [protected] |
ConfigMap torc::physical::XdlImporter::mConfigMap [protected] |
string torc::physical::XdlImporter::mConfigSetting [protected] |
string torc::physical::XdlImporter::mConfigName [protected] |
string torc::physical::XdlImporter::mConfigValue [protected] |
The documentation for this class was generated from the following files:
- torc/physical/XdlImporter.hpp
- torc/physical/XdlImporter.cpp
