torc::architecture::WireInfo Class Reference
Encapsulation of a wire within a tile type. More...
#include <WireInfo.hpp>
Collaboration diagram for torc::architecture::WireInfo:
Public Types | |
| enum | EWireFlag { eWireFlagNone = 0, eWireFlagHidden = 1, eWireFlagInput = 2, eWireFlagOutput = 4, eWireFlagRemote = 8, eWireFlagGlobal = 16, eWireFlagRemoteNodeCapable = 64, eWireFlagRemoteArcCapable = 128 } |
| Enumeration of wire attribute flags. More... | |
Public Member Functions | |
| WireInfo (void) | |
| Null constructor. | |
| ~WireInfo (void) | |
| Non-virtual destructor. | |
| const uint16_t | getArcOffset (void) const |
| Returns this wire's offset into the arc usage bitset. | |
| const WireFlags | getFlags (void) const |
| Returns the attribute flags for this wire. | |
| const char * | getName (void) const |
| Returns the name for this wire. | |
| const WireArray & | getTiedSinks (void) const |
| Returns the tied sink array for this wire. | |
| const WireArray & | getTiedSources (void) const |
| Returns the tied source array for this wire. | |
| const WireArray & | getSinks (void) const |
| Returns the sink array for this wire. | |
| const WireArray & | getSources (void) const |
| Returns the source array for this wire. | |
| const WireArray & | getIrregularSinks (void) const |
| Returns the irregular sink array for this wire. | |
| const WireArray & | getIrregularSources (void) const |
| Returns the irregular source array for this wire. | |
| const WireArray & | getRoutethroughSinks (void) const |
| Returns the routethrough sink array for this wire. | |
| const WireArray & | getRoutethroughSources (void) const |
| Returns the routethrough source array for this wire. | |
| bool | isHidden (void) const |
| Returns true if the wire is hidden in traces. | |
| bool | isInput (void) const |
| Returns true if the wire is a logic input. | |
| bool | isOutput (void) const |
| Returns true if the wire is a logic output. | |
| bool | isRemote (void) const |
| Returns true if the wire is a remote wire. | |
| bool | isGlobal (void) const |
| Returns true if the wire is a global wire (a what!?). | |
| bool | isRemoteNodeCapable (void) const |
| Returns true if the wire may be referenced by a remote wire. | |
| bool | isRemoteArcCapable (void) const |
| Returns true if the wire may be referenced by a remote arc. | |
Static Public Member Functions | |
| static bool | isHidden (WireFlags inWireFlags) |
| Returns true if the wire is hidden in traces. | |
| static bool | isInput (WireFlags inWireFlags) |
| Returns true if the wire is a logic input. | |
| static bool | isOutput (WireFlags inWireFlags) |
| Returns true if the wire is a logic output. | |
| static bool | isRemote (WireFlags inWireFlags) |
| Returns true if the wire is a remote wire. | |
| static bool | isGlobal (WireFlags inWireFlags) |
| Returns true if the wire is a global wire (a what!?). | |
| static bool | isRemoteNodeCapable (WireFlags inWireFlags) |
| Returns true if the wire may be referenced by a remote wire. | |
| static bool | isRemoteArcCapable (WireFlags inWireFlags) |
| Returns true if the wire may be referenced by a remote arc. | |
Protected Types | |
| typedef boost::uint16_t | uint16_t |
| Imported type name. | |
| typedef xilinx::WireFlags | WireFlags |
| Imported type name. | |
Protected Member Functions | |
| WireInfo (uint16_t inOffset, WireFlags inFlags, const char *inName) | |
| Protected constructor. | |
| WireInfo (const WireInfo &) | |
| Disabled copy constructor. | |
Protected Attributes | |
| uint16_t | mArcOffset |
| This wire's offset into the arc usage bitset. | |
| WireFlags | mFlags |
| The attribute flags for this wire. | |
| const char * | mName |
| The name for this wire. | |
| WireArray | mTiedSinks |
| The tied sink array for this wire. | |
| WireArray | mTiedSources |
| The tied source array for this wire. | |
| WireArray | mSinks |
| The sink array for this wire. | |
| WireArray | mSources |
| The source array for this wire. | |
| WireArray | mIrregularSinks |
| The irregular sink array for this wire. | |
| WireArray | mIrregularSources |
| The irregular source array for this wire. | |
| WireArray | mRoutethroughSinks |
| The routethrough sink array for this wire. | |
| WireArray | mRoutethroughSources |
| The routethrough source array for this wire. | |
Friends | |
| class | Tiles |
| The Tiles class has access to our protected members. | |
Detailed Description
Encapsulation of a wire within a tile type.The wire information includes the wire name, attribute flags, and arrays of all tied, regular, and irregular sources and sinks.
Definition at line 36 of file WireInfo.hpp.
Member Typedef Documentation
typedef boost::uint16_t torc::architecture::WireInfo::uint16_t [protected] |
typedef xilinx::WireFlags torc::architecture::WireInfo::WireFlags [protected] |
Member Enumeration Documentation
Constructor & Destructor Documentation
| torc::architecture::WireInfo::WireInfo | ( | const WireInfo & | ) | [inline, protected] |
| torc::architecture::WireInfo::WireInfo | ( | void | ) | [inline] |
| torc::architecture::WireInfo::~WireInfo | ( | void | ) | [inline] |
Member Function Documentation
| const uint16_t torc::architecture::WireInfo::getArcOffset | ( | void | ) | const [inline] |
Returns this wire's offset into the arc usage bitset.
Every wire in a tile type has a wire index, as well as zero or more arcs. The offset for this wire is the total number of arcs for all wires seen so far (i.e. wires of lower index).
Definition at line 105 of file WireInfo.hpp.
| const WireFlags torc::architecture::WireInfo::getFlags | ( | void | ) | const [inline] |
| const char* torc::architecture::WireInfo::getName | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getTiedSinks | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getTiedSources | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getSinks | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getSources | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getIrregularSinks | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getIrregularSources | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getRoutethroughSinks | ( | void | ) | const [inline] |
| const WireArray& torc::architecture::WireInfo::getRoutethroughSources | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isHidden | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isInput | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isOutput | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isRemote | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isGlobal | ( | void | ) | const [inline] |
| bool torc::architecture::WireInfo::isRemoteNodeCapable | ( | void | ) | const [inline] |
Returns true if the wire may be referenced by a remote wire.
Definition at line 138 of file WireInfo.hpp.
| bool torc::architecture::WireInfo::isRemoteArcCapable | ( | void | ) | const [inline] |
Returns true if the wire may be referenced by a remote arc.
Definition at line 140 of file WireInfo.hpp.
| static bool torc::architecture::WireInfo::isHidden | ( | WireFlags | inWireFlags | ) | [inline, static] |
| static bool torc::architecture::WireInfo::isInput | ( | WireFlags | inWireFlags | ) | [inline, static] |
| static bool torc::architecture::WireInfo::isOutput | ( | WireFlags | inWireFlags | ) | [inline, static] |
| static bool torc::architecture::WireInfo::isRemote | ( | WireFlags | inWireFlags | ) | [inline, static] |
| static bool torc::architecture::WireInfo::isGlobal | ( | WireFlags | inWireFlags | ) | [inline, static] |
| static bool torc::architecture::WireInfo::isRemoteNodeCapable | ( | WireFlags | inWireFlags | ) | [inline, static] |
Returns true if the wire may be referenced by a remote wire.
Definition at line 158 of file WireInfo.hpp.
| static bool torc::architecture::WireInfo::isRemoteArcCapable | ( | WireFlags | inWireFlags | ) | [inline, static] |
Returns true if the wire may be referenced by a remote arc.
Definition at line 161 of file WireInfo.hpp.
Friends And Related Function Documentation
friend class Tiles [friend] |
Member Data Documentation
uint16_t torc::architecture::WireInfo::mArcOffset [protected] |
WireFlags torc::architecture::WireInfo::mFlags [protected] |
const char* torc::architecture::WireInfo::mName [protected] |
WireArray torc::architecture::WireInfo::mTiedSinks [protected] |
WireArray torc::architecture::WireInfo::mTiedSources [protected] |
WireArray torc::architecture::WireInfo::mSinks [protected] |
WireArray torc::architecture::WireInfo::mSources [protected] |
The documentation for this class was generated from the following file:
- torc/architecture/WireInfo.hpp
