torc::ArchitectureBrowser Class Reference
Utility class for exploring database contents. More...
#include <ArchitectureBrowser.hpp>
Collaboration diagram for torc::ArchitectureBrowser:
Public Member Functions | |
| ArchitectureBrowser (DDB &inDB) | |
| Constructor. | |
| ~ArchitectureBrowser () | |
| Destructor. | |
| void | browse () |
| Function to begin an interactive browsing session. | |
| void | functionPrompt (const char *inPrompt, BrowserFunction f) |
| Secondary menu loop to remain in a particular function. | |
| void | deviceSummary () |
| A brief summary of device information. | |
| void | getTileList () |
| List all tiles. | |
| void | getFilteredTileList (const string &inString) |
| Filtered list of all tiles. | |
| void | getSiteList () |
| List of all sites. | |
| void | getFilteredSiteList (const string &inString) |
| Filtered list of all sites. | |
| void | getSiteDetail (const string &inString) |
| brief Site detail function. | |
| void | displaySitesOfType (const string &inString) |
| brief Sites of a particular type function. | |
| void | getTilewireDetail (const string &inString) |
| Tilewire detail function. | |
| void | displaySegmentSources (const string &inString) |
| Display source Tilewires of a segment. | |
| void | displaySegmentSinks (const string &inString) |
| Display sink Tilewires of a segment. | |
| void | displayFullSegment (const string &inString) |
| Display segment connectivity. | |
| void | displayFullSegmentFANCY (const string &inString) |
| Display segment connectivity. | |
| void | getWireListForTileType (const string &inString) |
| List all wires for a given tile type. | |
| void | enumerateSiteTypes () |
| Tilewire | stringToTilewire (const string &inString) |
| Convert user input to a Tilewire. | |
| void | printFullMenu () |
| Print the full menu of browser functions. | |
| void | setupFunctionMap () |
| Prepare function map to lookup what the user asks for. | |
Protected Types | |
| enum | EFunctionMap { eNotDefined, eQuit, eBit, eClear, eDetail, eFind, eGoto, eSinks, eInstances, eRoute, eSources, eWires, eTypes, eEquations, eeXtent, eMap, eSites, eSitePins, eSegment, eSiteTypes, eDeviceSummary, eTiles, eSiteDetail, eSitesOfType } |
| Enumeration of menu selection options. More... | |
| typedef std::string | string |
| Imported type name. | |
| typedef architecture::DDB | DDB |
| Imported type name. | |
| typedef architecture::PrimitiveDef | PrimitiveDef |
| Imported type name. | |
| typedef architecture::Segments | Segments |
| Imported type name. | |
| typedef architecture::Sites | Sites |
| Imported type name. | |
| typedef architecture::Tiles | Tiles |
| Imported type name. | |
| typedef architecture::ArcUsage | ArcUsage |
| Imported type name. | |
| typedef architecture::WireUsage | WireUsage |
| Imported type name. | |
| typedef architecture::Tilewire | Tilewire |
| Imported type name. | |
| typedef architecture::TilewireVector | TilewireVector |
| Imported type name. | |
| typedef architecture::WireInfo | WireInfo |
| Imported type name. | |
| typedef architecture::xilinx::TileIndex | TileIndex |
| Imported type name. | |
| typedef architecture::xilinx::TileCount | TileCount |
| Imported type name. | |
| typedef architecture::xilinx::WireIndex | WireIndex |
| Imported type name. | |
| typedef architecture::xilinx::TileTypeIndex | TileTypeIndex |
| Imported type name. | |
| typedef architecture::xilinx::SiteIndex | SiteIndex |
| Imported type name. | |
| typedef void(ArchitectureBrowser::* | BrowserFunction )(const std::string &x) |
| Type for member function pointers. | |
Protected Attributes | |
| DDB & | mDB |
| Database Reference. | |
| const Segments & | mSegments |
| Segments reference from the database. | |
| const Sites & | mSites |
| Site data reference from the database. | |
| const Tiles & | mTiles |
| Tile data reference from the database. | |
| ArcUsage & | mArcUsage |
| Pip usage information from the database. | |
| WireUsage & | mWireUsage |
| Wire usage information from the database. | |
| std::map< string, EFunctionMap > | mFunctionMap |
| Mapping from function to index. | |
Static Protected Attributes | |
| static boost::regex | sTilewireRegEx |
| Regular expression for Tilewire form. | |
| static boost::regex | sIndexRegEx |
| Regular expression for nonnegative integers. | |
| static boost::regex | sNameRegEx |
| Regular expression for a name. | |
Detailed Description
Utility class for exploring database contents.Definition at line 37 of file ArchitectureBrowser.hpp.
Member Typedef Documentation
typedef std::string torc::ArchitectureBrowser::string [protected] |
typedef architecture::DDB torc::ArchitectureBrowser::DDB [protected] |
typedef architecture::PrimitiveDef torc::ArchitectureBrowser::PrimitiveDef [protected] |
typedef architecture::Segments torc::ArchitectureBrowser::Segments [protected] |
typedef architecture::Sites torc::ArchitectureBrowser::Sites [protected] |
typedef architecture::Tiles torc::ArchitectureBrowser::Tiles [protected] |
typedef architecture::ArcUsage torc::ArchitectureBrowser::ArcUsage [protected] |
typedef architecture::WireUsage torc::ArchitectureBrowser::WireUsage [protected] |
typedef architecture::Tilewire torc::ArchitectureBrowser::Tilewire [protected] |
typedef architecture::TilewireVector torc::ArchitectureBrowser::TilewireVector [protected] |
typedef architecture::WireInfo torc::ArchitectureBrowser::WireInfo [protected] |
typedef architecture::xilinx::TileIndex torc::ArchitectureBrowser::TileIndex [protected] |
typedef architecture::xilinx::TileCount torc::ArchitectureBrowser::TileCount [protected] |
typedef architecture::xilinx::WireIndex torc::ArchitectureBrowser::WireIndex [protected] |
typedef architecture::xilinx::TileTypeIndex torc::ArchitectureBrowser::TileTypeIndex [protected] |
typedef architecture::xilinx::SiteIndex torc::ArchitectureBrowser::SiteIndex [protected] |
typedef void(ArchitectureBrowser::* torc::ArchitectureBrowser::BrowserFunction)(const std::string &x) [protected] |
Type for member function pointers.
Member Enumeration Documentation
enum torc::ArchitectureBrowser::EFunctionMap [protected] |
Constructor & Destructor Documentation
| torc::ArchitectureBrowser::ArchitectureBrowser | ( | DDB & | inDB | ) | [inline] |
| torc::ArchitectureBrowser::~ArchitectureBrowser | ( | ) | [inline] |
Member Function Documentation
| void torc::ArchitectureBrowser::browse | ( | ) | [inline] |
Function to begin an interactive browsing session.
Definition at line 118 of file ArchitectureBrowser.hpp.
| void torc::ArchitectureBrowser::functionPrompt | ( | const char * | inPrompt, | |
| BrowserFunction | f | |||
| ) | [inline] |
Secondary menu loop to remain in a particular function.
Definition at line 240 of file ArchitectureBrowser.hpp.
| void torc::ArchitectureBrowser::deviceSummary | ( | ) | [inline] |
| void torc::ArchitectureBrowser::getTileList | ( | ) | [inline] |
| void torc::ArchitectureBrowser::getFilteredTileList | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::getSiteList | ( | ) | [inline] |
| void torc::ArchitectureBrowser::getFilteredSiteList | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::getSiteDetail | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::displaySitesOfType | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::getTilewireDetail | ( | const string & | inString | ) | [inline] |
Tilewire detail function.
- Todo:
- SegmentReference with internal segment data?
Definition at line 428 of file ArchitectureBrowser.hpp.
| void torc::ArchitectureBrowser::displaySegmentSources | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::displaySegmentSinks | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::displayFullSegment | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::displayFullSegmentFANCY | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::getWireListForTileType | ( | const string & | inString | ) | [inline] |
| void torc::ArchitectureBrowser::printFullMenu | ( | ) |
| void torc::ArchitectureBrowser::setupFunctionMap | ( | ) |
Prepare function map to lookup what the user asks for.
Definition at line 48 of file ArchitectureBrowser.cpp.
Member Data Documentation
DDB& torc::ArchitectureBrowser::mDB [protected] |
const Segments& torc::ArchitectureBrowser::mSegments [protected] |
const Sites& torc::ArchitectureBrowser::mSites [protected] |
const Tiles& torc::ArchitectureBrowser::mTiles [protected] |
ArcUsage& torc::ArchitectureBrowser::mArcUsage [protected] |
WireUsage& torc::ArchitectureBrowser::mWireUsage [protected] |
boost::regex torc::ArchitectureBrowser::sTilewireRegEx [static, protected] |
boost::regex torc::ArchitectureBrowser::sIndexRegEx [static, protected] |
boost::regex torc::ArchitectureBrowser::sNameRegEx [static, protected] |
std::map<string, EFunctionMap> torc::ArchitectureBrowser::mFunctionMap [protected] |
The documentation for this class was generated from the following files:
- torc/utils/ArchitectureBrowser.hpp
- torc/utils/ArchitectureBrowser.cpp
