torc::physical::PrimitivePin Class Reference

Physical design primitive-pin. More...

#include <PrimitivePin.hpp>

Inheritance diagram for torc::physical::PrimitivePin:

Collaboration diagram for torc::physical::PrimitivePin:

Public Member Functions
const string &	getElementName (void) const
	Returns the element pointer or NULL. More...
const PinType	getType (void) const
	Returns pin type. More...
const string	getTypeString (void) const
	Returns the type string. More...
bool	operator== (const PrimitivePin &rhs) const
	Equality operator. More...
const string &	getName (void) const
	Returns the object name. More...
bool	operator== (const Named &rhs) const
	Equality operator. More...

Protected Types
typedef std::string	string

Protected Member Functions
	PrimitivePin (string inElementName, string inPinName, const PinType inType)
	Construct from primitive reference and pin name. More...

Protected Attributes
string	mElementName
	Element Name. More...
PinType	mType
	Type of pin. More...
string	mName
	The name of the object. More...

Friends
class	RcFactory
	The Factory class has direct access to our internals. More...

Detailed Description

Physical design primitive-pin.

This class specifies a pin on a physical design primitive.

Definition at line 36 of file packer/PrimitivePin.hpp.

Member Typedef Documentation

typedef std::string torc::physical::PrimitivePin::string

protected

Definition at line 41 of file packer/PrimitivePin.hpp.

Constructor & Destructor Documentation

torc::physical::PrimitivePin::PrimitivePin ( string  inElementName, string  inPinName, const PinType  inType  )

inlineprotected

Construct from primitive reference and pin name.

Definition at line 48 of file packer/PrimitivePin.hpp.

            : Named(inPinName), mElementName(inElementName), mType(inType) {}

Member Function Documentation

const string& torc::physical::PrimitivePin::getElementName ( void  ) const

inline

Returns the element pointer or NULL.

Definition at line 53 of file packer/PrimitivePin.hpp.

{ return mElementName; }

const string& torc::physical::Named::getName ( void  ) const

inlineinherited

Returns the object name.

Definition at line 51 of file Named.hpp.

{ return mName; }

Here is the caller graph for this function:

const PinType torc::physical::PrimitivePin::getType ( void  ) const

inline

Returns pin type.

Definition at line 55 of file packer/PrimitivePin.hpp.

{ return mType; }

const string torc::physical::PrimitivePin::getTypeString ( void  ) const

inline

Returns the type string.

Definition at line 58 of file packer/PrimitivePin.hpp.

                                               { 
            
            string sTmp = (mType==Unknown) ? "Unknown" : (mType==InputP) ? "input":"output";
            return sTmp;
        }

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

inlineinherited

Equality operator.

Definition at line 54 of file Named.hpp.

{ return mName == rhs.mName; }

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

inline

Equality operator.

Definition at line 65 of file packer/PrimitivePin.hpp.

                                                        { return mElementName == rhs.mElementName 
             && mName == rhs.mName && mType == mType; }

Friends And Related Function Documentation

friend class RcFactory

friend

The Factory class has direct access to our internals.

Definition at line 39 of file packer/PrimitivePin.hpp.

Field Documentation

string torc::physical::PrimitivePin::mElementName

protected

Element Name.

Definition at line 43 of file packer/PrimitivePin.hpp.

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

PinType torc::physical::PrimitivePin::mType

protected

Type of pin.

Definition at line 45 of file packer/PrimitivePin.hpp.

---

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

• packer/PrimitivePin.hpp