torc::architecture::InstancePin Class Reference

Physical design instance-pin pair, suitable for specifying a net endpoint. More...

#include <InstancePin.hpp>

Inheritance diagram for torc::architecture::InstancePin:

Collaboration diagram for torc::architecture::InstancePin:

Public Types
typedef boost::shared_ptr < class::torc::architecture::InstancePin >	ArchitectureInstancePinPtr
typedef boost::shared_ptr < class::torc::physical::InstancePin >	PhysicalInstancePinPtr

Public Member Functions
void	updateTilewire (class DDB &inDDB)
	Updates the Tilewire from the instance and pin names. More...
Tilewire &	getTilewire (void)
	Returns the Tilewire designated by this instance pin. More...
const InstanceWeakPtr &	getInstancePtr (void) const
	Returns the weak instance pointer. More...
const PinName &	getPinName (void) const
	Returns the pin name. More...
void	setInstancePtr (const InstanceWeakPtr &inInstancePtr)
	Sets the weak instance pointer. More...
void	setPinName (const string &inPinName)
	Sets the pin name. More...
bool	operator== (const InstancePinBase &rhs) const
	Equality operator. More...
const WeakPtrType &	getParentWeakPtr (void) const
	Returns a weak pointer to the parent. More...
void	setParentWeakPtr (WeakPtrType inParentPtr)
	Sets the weak pointer to the parent. More...
void	resetParentWeakPtr (void)
	Method to reset and orphan this object. More...
const SharedPtrType &	getParentSharedPtr (void) const
	Returns a shared pointer to the parent (WARNING: Does not work right). 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...
bool	operator< (const Tilewire &rhs) const
	Comparison operator. More...
bool	isUndefined (void) const

Static Public Member Functions
static ArchitectureInstancePinPtr &	physicalToArchitecture (PhysicalInstancePinPtr &inInstancePinSharedPtr)
	Typecasts a torc::physical::InstancePin to a torc::architecture::InstancePin. More...
static PhysicalInstancePinPtr &	architectureToPhysical (ArchitectureInstancePinPtr &inInstancePinSharedPtr)

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

Protected Types
typedef std::string	string
	Imported type name. More...
typedef boost::weak_ptr< class Net >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::weak_ptr < InstancePin >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::shared_ptr < class Net >	SharedPtrType
	Shared pointer of our own type. More...
typedef boost::shared_ptr < InstancePin >	SharedPtrType
	Shared pointer of our own type. More...
typedef xilinx::TileIndex	TileIndex
	Imported type name. More...
typedef xilinx::WireIndex	WireIndex
	Imported type name. More...

Protected Member Functions
	InstancePin (torc::physical::InstanceSharedPtr inInstancePtr, const string &inPinName)
	Protected constructor. More...
void	addToInstance (void)
	Asks the associated instance to add this pin from its pin map. More...
void	removeFromInstance (void)
	Asks the associated instance to remove this pin from its pin map. More...
void	setSelfWeakPtr (WeakPtrType inSelfPtr)
	Sets the weak pointer to this object. More...
const WeakPtrType &	getSelfWeakPtr (void) const
	Returns a weak pointer to this object. More...

Protected Attributes
InstanceWeakPtr	mInstancePtr
	The pin weak instance pointer. More...
PinName	mPinName
	The pin name. More...
WeakPtrType	mParentWeakPtr
	Weak pointer to the parent. More...
WeakPtrType	mSelfWeakPtr
	Weak pointer this object. More...
TileIndex	mTileIndex
	The tile index. More...
WireIndex	mWireIndex
	The wire index. More...

Private Member Functions
	InstancePin (const InstancePin &rhs)
	Disabled copy constructor. More...

Detailed Description

Physical design instance-pin pair, suitable for specifying a net endpoint.

This class is a Tilewire-aware version of torc::physical::InstancePin. It functions as an encapsulation of an InstancePin and its corresponding Tilewire.

Definition at line 31 of file architecture/InstancePin.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<class ::torc::architecture::InstancePin> torc::architecture::InstancePin::ArchitectureInstancePinPtr

Definition at line 45 of file architecture/InstancePin.hpp.

typedef boost::shared_ptr<class ::torc::physical::InstancePin> torc::architecture::InstancePin::PhysicalInstancePinPtr

Definition at line 46 of file architecture/InstancePin.hpp.

typedef boost::shared_ptr<class Net > torc::physical::Progeny< class Net >::SharedPtrType

protectedinherited

Shared pointer of our own type.

Definition at line 35 of file Progeny.hpp.

typedef boost::shared_ptr<InstancePin > torc::physical::Progenitor< InstancePin >::SharedPtrType

protectedinherited

Shared pointer of our own type.

Definition at line 52 of file Progenitor.hpp.

typedef std::string torc::physical::InstancePinBase::string

protectedinherited

Imported type name.

Definition at line 37 of file physical/InstancePin.hpp.

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

protectedinherited

Imported type name.

Definition at line 43 of file Tilewire.hpp.

typedef boost::weak_ptr<class Net > torc::physical::Progeny< class Net >::WeakPtrType

protectedinherited

Weak pointer of our own type.

Definition at line 33 of file Progeny.hpp.

typedef boost::weak_ptr<InstancePin > torc::physical::Progenitor< InstancePin >::WeakPtrType

protectedinherited

Weak pointer of our own type.

Definition at line 50 of file Progenitor.hpp.

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

protectedinherited

Imported type name.

Definition at line 45 of file Tilewire.hpp.

Constructor & Destructor Documentation

torc::architecture::InstancePin::InstancePin ( torc::physical::InstanceSharedPtr  inInstancePtr, const string &  inPinName  )

inlineprotected

Protected constructor.

Parameters

inInstancePtr	The pin instance pointer.
inPinName	The pin name.

Definition at line 37 of file architecture/InstancePin.hpp.

            : InstancePinBase(inInstancePtr, inPinName), Tilewire() {}

torc::architecture::InstancePin::InstancePin ( const InstancePin &  rhs )

inlineprivate

Disabled copy constructor.

Definition at line 42 of file architecture/InstancePin.hpp.

: InstancePinBase(rhs), Tilewire() {}

Member Function Documentation

void torc::physical::InstancePinBase::addToInstance ( void  )

inlineprotectedinherited

Asks the associated instance to add this pin from its pin map.

Definition at line 45 of file physical/InstancePin.hpp.

{ mInstancePtr.lock()->addPin(mSelfWeakPtr); }

static PhysicalInstancePinPtr& torc::architecture::InstancePin::architectureToPhysical ( ArchitectureInstancePinPtr &  inInstancePinSharedPtr )

inlinestatic

Definition at line 53 of file architecture/InstancePin.hpp.

                                                                {
            return reinterpret_cast<PhysicalInstancePinPtr&>(inInstancePinSharedPtr);
        }

const InstanceWeakPtr& torc::physical::InstancePinBase::getInstancePtr ( void  ) const

inlineinherited

Returns the weak instance pointer.

Definition at line 65 of file physical/InstancePin.hpp.

{ return mInstancePtr; }

Here is the caller graph for this function:

const SharedPtrType& torc::physical::Progeny< class Net >::getParentSharedPtr ( void  ) const

inlineinherited

Returns a shared pointer to the parent (WARNING: Does not work right).

Always seems to generate a "Returning reference to temporary" warning, and I cannot figure out why.

It is the caller's responsibility to reset the shared pointer when done.

Todo:

Figure out why Progeny<T>::getParentSharedPtr() yields a "Returning reference to temporary" warning.

Definition at line 59 of file Progeny.hpp.

{ return mParentWeakPtr.lock(); }

const WeakPtrType& torc::physical::Progeny< class Net >::getParentWeakPtr ( void  ) const

inlineinherited

Returns a weak pointer to the parent.

Definition at line 47 of file Progeny.hpp.

{ return mParentWeakPtr; }

const PinName& torc::physical::InstancePinBase::getPinName ( void  ) const

inlineinherited

Returns the pin name.

Definition at line 67 of file physical/InstancePin.hpp.

{ return mPinName; }

Here is the caller graph for this function:

const WeakPtrType& torc::physical::Progenitor< InstancePin >::getSelfWeakPtr ( void  ) const

inlineinherited

Returns a weak pointer to this object.

Definition at line 68 of file Progenitor.hpp.

{ return mSelfWeakPtr; }

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

inlineinherited

Returns the tile index.

Definition at line 64 of file Tilewire.hpp.

{ return mTileIndex; }

Here is the caller graph for this function:

Tilewire& torc::architecture::InstancePin::getTilewire ( void  )

inline

Returns the Tilewire designated by this instance pin.

Definition at line 62 of file architecture/InstancePin.hpp.

{ return static_cast<Tilewire&>(*this); }

Here is the caller graph for this function:

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

inlineinherited

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

inlineinherited

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

inlineinherited

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;
        }

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

inlineinherited

Equality operator.

Definition at line 73 of file Tilewire.hpp.

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

bool torc::physical::InstancePinBase::operator== ( const InstancePinBase &  rhs ) const

inlineinherited

Equality operator.

Definition at line 74 of file physical/InstancePin.hpp.

                                                           { 
            return !(mInstancePtr < rhs.mInstancePtr) && !(rhs.mInstancePtr < mInstancePtr) 
                && mPinName == rhs.mPinName; 
        }

static ArchitectureInstancePinPtr& torc::architecture::InstancePin::physicalToArchitecture ( PhysicalInstancePinPtr &  inInstancePinSharedPtr )

inlinestatic

Typecasts a torc::physical::InstancePin to a torc::architecture::InstancePin.

Definition at line 49 of file architecture/InstancePin.hpp.

                                                            {
            return reinterpret_cast<ArchitectureInstancePinPtr&>(inInstancePinSharedPtr);
        }

void torc::physical::InstancePinBase::removeFromInstance ( void  )

inlineprotectedinherited

Asks the associated instance to remove this pin from its pin map.

Definition at line 47 of file physical/InstancePin.hpp.

{ mInstancePtr.lock()->removePin(mSelfWeakPtr); }

Here is the caller graph for this function:

void torc::physical::Progeny< class Net >::resetParentWeakPtr ( void  )

inlineinherited

Method to reset and orphan this object.

Definition at line 51 of file Progeny.hpp.

{ mParentWeakPtr.reset(); }

void torc::physical::InstancePinBase::setInstancePtr ( const InstanceWeakPtr &  inInstancePtr )

inlineinherited

Sets the weak instance pointer.

Definition at line 69 of file physical/InstancePin.hpp.

{ mInstancePtr = inInstancePtr; }

void torc::physical::Progeny< class Net >::setParentWeakPtr ( WeakPtrType  inParentPtr )

inlineinherited

Sets the weak pointer to the parent.

Definition at line 49 of file Progeny.hpp.

{ mParentWeakPtr = inParentPtr; }

void torc::physical::InstancePinBase::setPinName ( const string &  inPinName )

inlineinherited

Sets the pin name.

Definition at line 71 of file physical/InstancePin.hpp.

{ mPinName = inPinName; }

void torc::physical::Progenitor< InstancePin >::setSelfWeakPtr ( WeakPtrType  inSelfPtr )

inlineprotectedinherited

Sets the weak pointer to this object.

Definition at line 59 of file Progenitor.hpp.

{ mSelfWeakPtr = inSelfPtr; }

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

inlineinherited

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 )

inlineinherited

Sets the wire index.

Definition at line 70 of file Tilewire.hpp.

{ mWireIndex = inWireIndex; }

Here is the caller graph for this function:

void torc::architecture::InstancePin::updateTilewire

(

class DDB &

inDDB

)

Updates the Tilewire from the instance and pin names.

Definition at line 25 of file architecture/InstancePin.cpp.

                                                     {
        torc::physical::InstanceWeakPtr instancePtr = getInstancePtr();
        if(instancePtr.expired()) return;
        getTilewire() = inDDB.sitePinToTilewire(instancePtr.lock()->getSite(), getPinName());
    }

Here is the call graph for this function:

Field Documentation

InstanceWeakPtr torc::physical::InstancePinBase::mInstancePtr

protectedinherited

The pin weak instance pointer.

Definition at line 40 of file physical/InstancePin.hpp.

WeakPtrType torc::physical::Progeny< class Net >::mParentWeakPtr

protectedinherited

Weak pointer to the parent.

Definition at line 38 of file Progeny.hpp.

PinName torc::physical::InstancePinBase::mPinName

protectedinherited

The pin name.

Definition at line 42 of file physical/InstancePin.hpp.

WeakPtrType torc::physical::Progenitor< InstancePin >::mSelfWeakPtr

protectedinherited

Weak pointer this object.

This weak pointer is kept here to be passed along to our children, allowing them to point back to us without the strong dependency of a shared pointer.

Definition at line 57 of file Progenitor.hpp.

TileIndex torc::architecture::Tilewire::mTileIndex

protectedinherited

The tile index.

Definition at line 48 of file Tilewire.hpp.

WireIndex torc::architecture::Tilewire::mWireIndex

protectedinherited

The wire index.

Definition at line 50 of file Tilewire.hpp.

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

staticinherited

Definition at line 93 of file Tilewire.hpp.

---

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

• architecture/InstancePin.hpp
• architecture/InstancePin.cpp