torc::physical::Pip Class Reference

Physical design programmable interconnect point. More...

#include <Pip.hpp>

Inheritance diagram for torc::physical::Pip:

[legend]

Collaboration diagram for torc::physical::Pip:

[legend]

List of all members.

Public Member Functions
const TileName &	getTileName (void) const
	Returns the pip tile.
const WireName &	getSourceWireName (void) const
	Returns the pip source wire.
const WireName &	getSinkWireName (void) const
	Returns the pip sink wire.
EPipDirection	getDirection (void) const
	Returns the pip directionality.
const char *	getDirectionString (void) const
	Returns the pip directionality as a string.
RoutethroughSharedPtr	getRoutethroughPtr (void) const
	Returns the pip's routethrough pointer.
bool	isRoutethrough (void) const
	Indicates whether or not the pip has an associated routethrough.
bool	operator== (const Pip &rhs) const
	Equality operator.
Static Public Member Functions
static const char *	getDirectionString (EPipDirection inPipDirection)
	Returns the pip directionality as a string.
Protected Types
typedef std::string	string
	Imported type name.
Protected Member Functions
	Pip (const string &inTileName, const string &inSourceWireName, const string &inSinkWireName, EPipDirection inPipDirection, RoutethroughSharedPtr inRoutethroughPtr)
	Protected constructor.
Protected Attributes
TileName	mTileName
	The containing tile for this pip.
WireName	mSourceWireName
	The source wire for this pip.
WireName	mSinkWireName
	The sink wire for this pip.
EPipDirection	mDirection
	The connection directionality for this pip. See EPipDirection.
RoutethroughSharedPtr	mRoutethroughPtr
	The routethrough shared pointer.
Static Protected Attributes
static const char *	sPipDirectionStrings []
	String representation of pip directions.
Friends
class	Factory
	The Factory class has direct access to our internals.

---

Detailed Description

Physical design programmable interconnect point.

This class represents a pip (programmable interconnect point) on a physical design

Definition at line 34 of file Pip.hpp.

---

Member Typedef Documentation

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

Imported type name.

Definition at line 41 of file Pip.hpp.

---

Constructor & Destructor Documentation

torc::physical::Pip::Pip	(	const string &	inTileName,
		const string &	inSourceWireName,
		const string &	inSinkWireName,
		EPipDirection	inPipDirection,
		RoutethroughSharedPtr	inRoutethroughPtr
	)			[inline, protected]

Protected constructor.

Parameters:

	inTileName	The containing tile.
	inSourceWireName	The source wire.
	inSinkWireName	The sink wire.
	inPipDirection	The pip directionality. See EPipDirection.
	inRoutethroughPtr	The routethrough shared pointer.

Definition at line 62 of file Pip.hpp.

---

Member Function Documentation

const char * torc::physical::Pip::getDirectionString

(

EPipDirection

inPipDirection

)

[static]

Returns the pip directionality as a string.

Definition at line 36 of file Pip.cpp.

const TileName& torc::physical::Pip::getTileName

(

void

)

const [inline]

Returns the pip tile.

Definition at line 73 of file Pip.hpp.

const WireName& torc::physical::Pip::getSourceWireName

(

void

)

const [inline]

Returns the pip source wire.

Definition at line 75 of file Pip.hpp.

const WireName& torc::physical::Pip::getSinkWireName

(

void

)

const [inline]

Returns the pip sink wire.

Definition at line 77 of file Pip.hpp.

EPipDirection torc::physical::Pip::getDirection

(

void

)

const [inline]

Returns the pip directionality.

Definition at line 79 of file Pip.hpp.

const char * torc::physical::Pip::getDirectionString

(

void

)

const

Returns the pip directionality as a string.

Definition at line 32 of file Pip.cpp.

RoutethroughSharedPtr torc::physical::Pip::getRoutethroughPtr

(

void

)

const [inline]

Returns the pip's routethrough pointer.

Definition at line 83 of file Pip.hpp.

bool torc::physical::Pip::isRoutethrough

(

void

)

const [inline]

Indicates whether or not the pip has an associated routethrough.

Definition at line 86 of file Pip.hpp.

bool torc::physical::Pip::operator==

(

const Pip &

rhs

)

const [inline]

Equality operator.

Definition at line 89 of file Pip.hpp.

---

Friends And Related Function Documentation

friend class Factory [friend]

The Factory class has direct access to our internals.

Definition at line 37 of file Pip.hpp.

---

Member Data Documentation

TileName torc::physical::Pip::mTileName [protected]

The containing tile for this pip.

Definition at line 44 of file Pip.hpp.

WireName torc::physical::Pip::mSourceWireName [protected]

The source wire for this pip.

Definition at line 46 of file Pip.hpp.

WireName torc::physical::Pip::mSinkWireName [protected]

The sink wire for this pip.

Definition at line 48 of file Pip.hpp.

EPipDirection torc::physical::Pip::mDirection [protected]

The connection directionality for this pip. See EPipDirection.

Definition at line 50 of file Pip.hpp.

RoutethroughSharedPtr torc::physical::Pip::mRoutethroughPtr [protected]

The routethrough shared pointer.

Definition at line 52 of file Pip.hpp.

const char * torc::physical::Pip::sPipDirectionStrings [static, protected]

Initial value:

 {
        "==", 
        "=>", 
        "=-", 
        "->"  
    }

String representation of pip directions.

Definition at line 54 of file Pip.hpp.

---

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

• torc/physical/Pip.hpp
• torc/physical/Pip.cpp