torc::physical::InstancePinBase Class Reference

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

#include <InstancePin.hpp>

Inheritance diagram for torc::physical::InstancePinBase:

[legend]

Collaboration diagram for torc::physical::InstancePinBase:

[legend]

List of all members.

Public Member Functions
	~InstancePinBase (void)
	Non-virtual destructor.
const InstanceWeakPtr &	getInstancePtr (void) const
	Returns the weak instance pointer.
const PinName &	getPinName (void) const
	Returns the pin name.
void	setInstancePtr (const InstanceWeakPtr &inInstancePtr)
	Sets the weak instance pointer.
void	setPinName (const string &inPinName)
	Sets the pin name.
bool	operator== (const InstancePinBase &rhs) const
	Equality operator.
Protected Types
typedef std::string	string
	Imported type name.
Protected Member Functions
void	addToInstance (void)
	Asks the associated instance to add this pin from its pin map.
void	removeFromInstance (void)
	Asks the associated instance to remove this pin from its pin map.
	InstancePinBase (InstanceSharedPtr inInstancePtr, const string &inPinName)
	Protected constructor.
	InstancePinBase (const InstancePin &)
	Disabled copy constructor.
void	operator= (const InstancePin &)
	Disabled assignment operator.
Protected Attributes
InstanceWeakPtr	mInstancePtr
	The pin weak instance pointer.
PinName	mPinName
	The pin name.

---

Detailed Description

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

This class specifies a pin on a physical design instance.

See also:

SitePin.

Definition at line 33 of file InstancePin.hpp.

---

Member Typedef Documentation

typedef std::string torc::physical::InstancePinBase::string [protected]

Imported type name.

Definition at line 37 of file InstancePin.hpp.

---

Constructor & Destructor Documentation

torc::physical::InstancePinBase::InstancePinBase	(	InstanceSharedPtr	inInstancePtr,
		const string &	inPinName
	)			[inline, protected]

Protected constructor.

Parameters:

	inInstancePtr	The pin instance pointer.
	inPinName	The pin name.

Definition at line 52 of file InstancePin.hpp.

torc::physical::InstancePinBase::InstancePinBase

(

const InstancePin &

)

[inline, protected]

Disabled copy constructor.

Definition at line 55 of file InstancePin.hpp.

torc::physical::InstancePinBase::~InstancePinBase

(

void

)

[inline]

Non-virtual destructor.

Definition at line 62 of file InstancePin.hpp.

---

Member Function Documentation

void torc::physical::InstancePinBase::addToInstance

(

void

)

[inline, protected]

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

Definition at line 45 of file InstancePin.hpp.

void torc::physical::InstancePinBase::removeFromInstance

(

void

)

[inline, protected]

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

Definition at line 47 of file InstancePin.hpp.

void torc::physical::InstancePinBase::operator=

(

const InstancePin &

)

[inline, protected]

Disabled assignment operator.

Definition at line 58 of file InstancePin.hpp.

const InstanceWeakPtr& torc::physical::InstancePinBase::getInstancePtr

(

void

)

const [inline]

Returns the weak instance pointer.

Definition at line 65 of file InstancePin.hpp.

const PinName& torc::physical::InstancePinBase::getPinName

(

void

)

const [inline]

Returns the pin name.

Definition at line 67 of file InstancePin.hpp.

void torc::physical::InstancePinBase::setInstancePtr

(

const InstanceWeakPtr &

inInstancePtr

)

[inline]

Sets the weak instance pointer.

Definition at line 69 of file InstancePin.hpp.

void torc::physical::InstancePinBase::setPinName

(

const string &

inPinName

)

[inline]

Sets the pin name.

Definition at line 71 of file InstancePin.hpp.

bool torc::physical::InstancePinBase::operator==

(

const InstancePinBase &

rhs

)

const [inline]

Equality operator.

Definition at line 74 of file InstancePin.hpp.

---

Member Data Documentation

InstanceWeakPtr torc::physical::InstancePinBase::mInstancePtr [protected]

The pin weak instance pointer.

Definition at line 40 of file InstancePin.hpp.

PinName torc::physical::InstancePinBase::mPinName [protected]

The pin name.

Definition at line 42 of file InstancePin.hpp.

---

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

• torc/physical/InstancePin.hpp