torc::architecture::Tilewire Class Reference

Encapsulation of a device tile and wire pair. More...

#include <Tilewire.hpp>

Inheritance diagram for torc::architecture::Tilewire:

Collaboration diagram for torc::architecture::Tilewire:

Public Member Functions
	Tilewire (void)
	Null constructor. More...
	Tilewire (const TileIndex &inTileIndex, const WireIndex &inWireIndex)
	Public constructor. More...
	Tilewire (const Tilewire &inTilewire)
	Copy constructor. More...
const TileIndex &	getTileIndex (void) const
	Returns the tile index. More...
const WireIndex &	getWireIndex (void) const
	Returns the wire index. More...
void	setTileIndex (const TileIndex &inTileIndex)
	Sets the tile index. More...
void	setWireIndex (const WireIndex &inWireIndex)
	Sets the wire index. More...
bool	operator== (const Tilewire &rhs) const
	Equality operator. More...
const Tilewire &	operator= (const Tilewire &rhs)
	Assignment operator. More...
bool	operator< (const Tilewire &rhs) const
	Comparison operator. More...
bool	isUndefined (void) const

Static Public Attributes
static const Tilewire	sInvalid = Tilewire(TileIndex(-1), WireIndex(-1))

Protected Types
typedef xilinx::TileIndex	TileIndex
	Imported type name. More...
typedef xilinx::WireIndex	WireIndex
	Imported type name. More...

Protected Attributes
TileIndex	mTileIndex
	The tile index. More...
WireIndex	mWireIndex
	The wire index. More...

Friends
std::size_t	hash_value (const Tilewire &inTilewire)
	Return a hash value for the specified tilewire. More...

Detailed Description

Encapsulation of a device tile and wire pair.

Todo:

Have to justify the packing decision, and its impact on memory footprint versus performance.

A tilewire uniquely identifies a physical wire in the device, as defined by its tile index and wire index. Tilewires are used extensively by the device database, and by the router and tracer classes.

Definition at line 39 of file Tilewire.hpp.

Member Typedef Documentation

typedef xilinx::TileIndex torc::architecture::Tilewire::TileIndex

protected

Imported type name.

Definition at line 43 of file Tilewire.hpp.

typedef xilinx::WireIndex torc::architecture::Tilewire::WireIndex

protected

Imported type name.

Definition at line 45 of file Tilewire.hpp.

Constructor & Destructor Documentation

torc::architecture::Tilewire::Tilewire ( void  )

inline

Null constructor.

The tilewire will be set to Tilewire::sInvalid.

Definition at line 55 of file Tilewire.hpp.

: mTileIndex(TileIndex::undefined()), mWireIndex(WireIndex::undefined()) {}

torc::architecture::Tilewire::Tilewire ( const TileIndex &  inTileIndex, const WireIndex &  inWireIndex  )

inline

Public constructor.

Definition at line 57 of file Tilewire.hpp.

            : mTileIndex(inTileIndex), mWireIndex(inWireIndex) {}

torc::architecture::Tilewire::Tilewire ( const Tilewire &  inTilewire )

inline

Copy constructor.

Definition at line 60 of file Tilewire.hpp.

            : mTileIndex(inTilewire.mTileIndex), mWireIndex(inTilewire.mWireIndex) {}

Member Function Documentation

const TileIndex& torc::architecture::Tilewire::getTileIndex ( void  ) const

inline

Returns the tile index.

Definition at line 64 of file Tilewire.hpp.

{ return mTileIndex; }

Here is the caller graph for this function:

const WireIndex& torc::architecture::Tilewire::getWireIndex ( void  ) const

inline

Returns the wire index.

Definition at line 66 of file Tilewire.hpp.

{ return mWireIndex; }

Here is the caller graph for this function:

bool torc::architecture::Tilewire::isUndefined ( void  ) const

inline

Definition at line 86 of file Tilewire.hpp.

                                     {
            return mTileIndex.isUndefined() || mWireIndex.isUndefined();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

bool torc::architecture::Tilewire::operator< ( const Tilewire &  rhs ) const

inline

Comparison operator.

This operator facilitates ordering in containers.

Definition at line 80 of file Tilewire.hpp.

                                                   {
            if(mTileIndex < rhs.mTileIndex) return true;
            if(mTileIndex == rhs.mTileIndex && mWireIndex < rhs.mWireIndex) return true;
            return false;
        }

const Tilewire& torc::architecture::Tilewire::operator= ( const Tilewire &  rhs )

inline

Assignment operator.

Definition at line 76 of file Tilewire.hpp.

            { mTileIndex = rhs.mTileIndex; mWireIndex = rhs.mWireIndex; return *this; }

bool torc::architecture::Tilewire::operator== ( const Tilewire &  rhs ) const

inline

Equality operator.

Definition at line 73 of file Tilewire.hpp.

            { return mTileIndex == rhs.mTileIndex && mWireIndex == rhs.mWireIndex; }

void torc::architecture::Tilewire::setTileIndex ( const TileIndex &  inTileIndex )

inline

Sets the tile index.

Definition at line 68 of file Tilewire.hpp.

{ mTileIndex = inTileIndex; }

Here is the caller graph for this function:

void torc::architecture::Tilewire::setWireIndex ( const WireIndex &  inWireIndex )

inline

Sets the wire index.

Definition at line 70 of file Tilewire.hpp.

{ mWireIndex = inWireIndex; }

Here is the caller graph for this function:

Friends And Related Function Documentation

std::size_t hash_value ( const Tilewire &  inTilewire )

friend

Return a hash value for the specified tilewire.

Definition at line 27 of file Tilewire.cpp.

                                                     {
        std::size_t seed = 0;
        boost::hash_combine(seed, inTilewire.getTileIndex());
        boost::hash_combine(seed, inTilewire.getWireIndex());
        return seed;
    }

Field Documentation

TileIndex torc::architecture::Tilewire::mTileIndex

protected

The tile index.

Definition at line 48 of file Tilewire.hpp.

WireIndex torc::architecture::Tilewire::mWireIndex

protected

The wire index.

Definition at line 50 of file Tilewire.hpp.

const Tilewire torc::architecture::Tilewire::sInvalid = Tilewire(TileIndex(-1), WireIndex(-1))

static

Definition at line 93 of file Tilewire.hpp.

---

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

• Tilewire.hpp
• Tilewire.cpp