torc::architecture::PrimitiveDef Class Reference

Encapsulation of primitive site definition, with associated connections, elements, and pins. More...

#include <PrimitiveDef.hpp>

Collaboration diagram for torc::architecture::PrimitiveDef:

Public Member Functions
	PrimitiveDef (void)
	Null constructor. This constructor should only be used by containers. More...
PinIndex	findPinIndexByName (const std::string &inName) const
	Returns the pin index corresponding to the given pin name, or PinIndex::undefined() if the pin name does not exist. inName The pin name to find. More...
const string &	getName (void) const
	Returns the name of the primitive. More...
const PrimitivePinArray &	getPins (void) const
	Returns a constant array of primitive pins. More...
const PrimitiveElementArray &	getElements (void) const
	Returns a constant array of primitive elements. More...
const PrimitiveConnSharedPtrArray &	getConnections (void) const
	Returns a constant array of primitive connection shared pointers. More...

Protected Types
typedef xilinx::PinIndex	PinIndex
	Imported type name. More...
typedef std::string	string
	Imported type name. More...
typedef std::map< std::string, PinIndex >	PinNameToPinIndexMap
	Map of pin names to pin indexes for a primitive element. More...

Protected Member Functions
PrimitivePinArray &	getPins (void)
	Returns a non-constant array of element pins. This function should only be used by the Sites class during database iniialization. More...

Protected Attributes
std::string	mName
	The primitive name. More...
PrimitivePinArray	mPins
	The primitive pins. More...
PrimitiveElementArray	mElements
	The primitive elements. More...
PrimitiveConnSharedPtrArray	mConnections
	The primitive internal connections. More...
PinNameToPinIndexMap	mPinNameToPinIndex
	The map of pin names to pin indexes. More...

Friends
class	Sites

Detailed Description

Encapsulation of primitive site definition, with associated connections, elements, and pins.

Definition at line 30 of file PrimitiveDef.hpp.

Member Typedef Documentation

typedef xilinx::PinIndex torc::architecture::PrimitiveDef::PinIndex

protected

Imported type name.

Definition at line 35 of file PrimitiveDef.hpp.

typedef std::map<std::string, PinIndex> torc::architecture::PrimitiveDef::PinNameToPinIndexMap

protected

Map of pin names to pin indexes for a primitive element.

Definition at line 38 of file PrimitiveDef.hpp.

typedef std::string torc::architecture::PrimitiveDef::string

protected

Imported type name.

Definition at line 36 of file PrimitiveDef.hpp.

Constructor & Destructor Documentation

torc::architecture::PrimitiveDef::PrimitiveDef ( void  )

inline

Null constructor. This constructor should only be used by containers.

Definition at line 59 of file PrimitiveDef.hpp.

: mName(), mPins(), mPinNameToPinIndex() {}

Member Function Documentation

PinIndex torc::architecture::PrimitiveDef::findPinIndexByName ( const std::string &  inName ) const

inline

Returns the pin index corresponding to the given pin name, or PinIndex::undefined() if the pin name does not exist. inName The pin name to find.

Definition at line 64 of file PrimitiveDef.hpp.

                                                                   {
            PinNameToPinIndexMap::const_iterator p = mPinNameToPinIndex.find(inName);
            return (p == mPinNameToPinIndex.end()) 
                ? PinIndex(PinIndex::undefined()) : p->second;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

const PrimitiveConnSharedPtrArray& torc::architecture::PrimitiveDef::getConnections ( void  ) const

inline

Returns a constant array of primitive connection shared pointers.

Definition at line 77 of file PrimitiveDef.hpp.

{ return mConnections; }

Here is the caller graph for this function:

const PrimitiveElementArray& torc::architecture::PrimitiveDef::getElements ( void  ) const

inline

Returns a constant array of primitive elements.

Definition at line 75 of file PrimitiveDef.hpp.

{ return mElements; }

Here is the caller graph for this function:

const string& torc::architecture::PrimitiveDef::getName ( void  ) const

inline

Returns the name of the primitive.

Definition at line 71 of file PrimitiveDef.hpp.

{ return mName; }

Here is the caller graph for this function:

PrimitivePinArray& torc::architecture::PrimitiveDef::getPins ( void  )

inlineprotected

Returns a non-constant array of element pins. This function should only be used by the Sites class during database iniialization.

Definition at line 54 of file PrimitiveDef.hpp.

{ return mPins; }

Here is the caller graph for this function:

const PrimitivePinArray& torc::architecture::PrimitiveDef::getPins ( void  ) const

inline

Returns a constant array of primitive pins.

Definition at line 73 of file PrimitiveDef.hpp.

{ return mPins; }

Friends And Related Function Documentation

friend class Sites

friend

Definition at line 33 of file PrimitiveDef.hpp.

Field Documentation

PrimitiveConnSharedPtrArray torc::architecture::PrimitiveDef::mConnections

protected

The primitive internal connections.

Definition at line 47 of file PrimitiveDef.hpp.

PrimitiveElementArray torc::architecture::PrimitiveDef::mElements

protected

The primitive elements.

Definition at line 45 of file PrimitiveDef.hpp.

std::string torc::architecture::PrimitiveDef::mName

protected

The primitive name.

Definition at line 41 of file PrimitiveDef.hpp.

PinNameToPinIndexMap torc::architecture::PrimitiveDef::mPinNameToPinIndex

protected

The map of pin names to pin indexes.

Definition at line 49 of file PrimitiveDef.hpp.

PrimitivePinArray torc::architecture::PrimitiveDef::mPins

protected

The primitive pins.

Definition at line 43 of file PrimitiveDef.hpp.

---

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

• PrimitiveDef.hpp