torc::architecture::Site Class Reference

Encapsulation of a device logic site. More...

#include <Site.hpp>

Collaboration diagram for torc::architecture::Site:

Public Types
typedef Array< const WireIndex >	WireIndexArray
	Array of constant wire indexes. More...

Public Member Functions
	Site (void)
	Null constructor (for use in containers only). More...
const Tilewire	getPinTilewire (const std::string &inName) const
	Returns the Tilewire associated with the specified pin name. More...
const string &	getName (void) const
	Returns the site name. More...
const PrimitiveDef *	getPrimitiveDefPtr (void) const
	Returns a pointer to the associated primitive definition. More...
TileIndex	getTileIndex (void) const
	Returns the index of the containing tile. More...
SiteFlags	getFlags (void) const
	Returns the flags associated with this site. More...
const WireIndexArray *	getPinMapPtr (void) const
	Returns the pin to wire map for this site. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef xilinx::PinIndex	PinIndex
	Imported type name. More...
typedef xilinx::TileIndex	TileIndex
	Imported type name. More...
typedef xilinx::WireIndex	WireIndex
	Imported type name. More...
typedef xilinx::SiteFlags	SiteFlags
	Imported type name. More...

Protected Member Functions
	Site (const string &inName, const PrimitiveDef &inPrimitiveDef, TileIndex inTileIndex, SiteFlags inFlags, const WireIndexArray &inPinMap)
	Protected constructor. More...

Protected Attributes
string	mName
	The logic site name. More...
const PrimitiveDef *	mPrimitiveDefPtr
	Pointer to the associated primitive definition. More...
TileIndex	mTileIndex
	The index of the containing tile. More...
SiteFlags	mFlags
	The flags associated with this site. More...
const WireIndexArray *	mPinMapPtr
	The pin to wire map for this site. More...

Friends
class	Sites
	The Sites class has access to our internals. More...

Detailed Description

Encapsulation of a device logic site.

Definition at line 30 of file Site.hpp.

Member Typedef Documentation

typedef xilinx::PinIndex torc::architecture::Site::PinIndex

protected

Imported type name.

Definition at line 37 of file Site.hpp.

typedef xilinx::SiteFlags torc::architecture::Site::SiteFlags

protected

Imported type name.

Definition at line 40 of file Site.hpp.

typedef std::string torc::architecture::Site::string

protected

Imported type name.

Definition at line 36 of file Site.hpp.

typedef xilinx::TileIndex torc::architecture::Site::TileIndex

protected

Imported type name.

Definition at line 38 of file Site.hpp.

typedef xilinx::WireIndex torc::architecture::Site::WireIndex

protected

Imported type name.

Definition at line 39 of file Site.hpp.

typedef Array<const WireIndex> torc::architecture::Site::WireIndexArray

Array of constant wire indexes.

Definition at line 44 of file Site.hpp.

Constructor & Destructor Documentation

torc::architecture::Site::Site ( const string &  inName, const PrimitiveDef &  inPrimitiveDef, TileIndex  inTileIndex, SiteFlags  inFlags, const WireIndexArray &  inPinMap  )

inlineprotected

Protected constructor.

Definition at line 59 of file Site.hpp.

            : mName(inName), mPrimitiveDefPtr(&inPrimitiveDef), mTileIndex(inTileIndex), 
            mFlags(inFlags), mPinMapPtr(&inPinMap) {
        }

torc::architecture::Site::Site ( void  )

inline

Null constructor (for use in containers only).

Definition at line 67 of file Site.hpp.

: mName(), mPrimitiveDefPtr(0), mTileIndex(), mFlags(), mPinMapPtr(0) {}

Member Function Documentation

SiteFlags torc::architecture::Site::getFlags ( void  ) const

inline

Returns the flags associated with this site.

Definition at line 85 of file Site.hpp.

{ return mFlags; }

Here is the caller graph for this function:

const string& torc::architecture::Site::getName ( void  ) const

inline

Returns the site name.

Definition at line 79 of file Site.hpp.

{ return mName; }

Here is the caller graph for this function:

const WireIndexArray* torc::architecture::Site::getPinMapPtr ( void  ) const

inline

Returns the pin to wire map for this site.

Definition at line 87 of file Site.hpp.

{ return mPinMapPtr; }

Here is the caller graph for this function:

const Tilewire torc::architecture::Site::getPinTilewire ( const std::string &  inName ) const

inline

Returns the Tilewire associated with the specified pin name.

Definition at line 70 of file Site.hpp.

                                                                     {
            if(mPrimitiveDefPtr == 0) return Tilewire::sInvalid;
            PinIndex pinIndex = mPrimitiveDefPtr->findPinIndexByName(inName);
            if(pinIndex.isUndefined()) return Tilewire::sInvalid;
            if(mPinMapPtr == 0) return Tilewire::sInvalid;
            return Tilewire(mTileIndex, (*mPinMapPtr)[pinIndex]);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

const PrimitiveDef* torc::architecture::Site::getPrimitiveDefPtr ( void  ) const

inline

Returns a pointer to the associated primitive definition.

Definition at line 81 of file Site.hpp.

{ return mPrimitiveDefPtr; }

Here is the caller graph for this function:

TileIndex torc::architecture::Site::getTileIndex ( void  ) const

inline

Returns the index of the containing tile.

Definition at line 83 of file Site.hpp.

{ return mTileIndex; }

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class Sites

friend

The Sites class has access to our internals.

Definition at line 34 of file Site.hpp.

Field Documentation

SiteFlags torc::architecture::Site::mFlags

protected

The flags associated with this site.

Definition at line 54 of file Site.hpp.

string torc::architecture::Site::mName

protected

The logic site name.

Definition at line 48 of file Site.hpp.

const WireIndexArray* torc::architecture::Site::mPinMapPtr

protected

The pin to wire map for this site.

Definition at line 56 of file Site.hpp.

const PrimitiveDef* torc::architecture::Site::mPrimitiveDefPtr

protected

Pointer to the associated primitive definition.

Definition at line 50 of file Site.hpp.

TileIndex torc::architecture::Site::mTileIndex

protected

The index of the containing tile.

Definition at line 52 of file Site.hpp.

---

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

• Site.hpp