torc-master
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
torc::physical::ConnectionPin Class Reference

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

#include <ConnectionPin.hpp>

+ Collaboration diagram for torc::physical::ConnectionPin:

Public Member Functions

 ConnectionPin ()
 NULL connection pin. More...
 
const stringgetElementName (void) const
 Returns the element pointer or NULL. More...
 
const PinNamegetPinName (void) const
 Returns the pin name. More...
 
bool operator== (const ConnectionPin &rhs) const
 Equality operator. More...
 

Protected Types

typedef std::string string
 

Protected Member Functions

 ConnectionPin (string inElementName, const string &inPinName)
 Construct from connection reference and pin name. More...
 

Protected Attributes

string mElementName
 Element Name. More...
 
PinName mPinName
 Name of the pin. More...
 

Friends

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

Detailed Description

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

This class specifies a pin on a physical design connection.

Definition at line 31 of file ConnectionPin.hpp.

Member Typedef Documentation

typedef std::string torc::physical::ConnectionPin::string
protected

Definition at line 36 of file ConnectionPin.hpp.

Constructor & Destructor Documentation

torc::physical::ConnectionPin::ConnectionPin ( string  inElementName,
const string inPinName 
)
inlineprotected

Construct from connection reference and pin name.

Definition at line 44 of file ConnectionPin.hpp.

45  : mElementName(inElementName), mPinName(inPinName) {}
string mElementName
Element Name.
PinName mPinName
Name of the pin.
torc::physical::ConnectionPin::ConnectionPin ( )
inline

NULL connection pin.

Definition at line 48 of file ConnectionPin.hpp.

49  : mElementName("NULL"), mPinName("NULL") {}
string mElementName
Element Name.
PinName mPinName
Name of the pin.

Member Function Documentation

const string& torc::physical::ConnectionPin::getElementName ( void  ) const
inline

Returns the element pointer or NULL.

Definition at line 51 of file ConnectionPin.hpp.

51 { return mElementName; }
string mElementName
Element Name.

+ Here is the caller graph for this function:

const PinName& torc::physical::ConnectionPin::getPinName ( void  ) const
inline

Returns the pin name.

Definition at line 53 of file ConnectionPin.hpp.

53 { return mPinName; }
PinName mPinName
Name of the pin.

+ Here is the caller graph for this function:

bool torc::physical::ConnectionPin::operator== ( const ConnectionPin rhs) const
inline

Equality operator.

Definition at line 55 of file ConnectionPin.hpp.

55  { return mElementName == rhs.mElementName
56  && mPinName == rhs.mPinName; }
string mElementName
Element Name.
PinName mPinName
Name of the pin.

Friends And Related Function Documentation

friend class RcFactory
friend

The Factory class has direct access to our internals.

Definition at line 34 of file ConnectionPin.hpp.

Field Documentation

string torc::physical::ConnectionPin::mElementName
protected

Element Name.

Definition at line 39 of file ConnectionPin.hpp.

PinName torc::physical::ConnectionPin::mPinName
protected

Name of the pin.

Definition at line 41 of file ConnectionPin.hpp.


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