torc::architecture::Package Class Reference

Encapsulation of a physical device package and its pins. More...

#include <Package.hpp>

Collaboration diagram for torc::architecture::Package:

Public Member Functions
	Package (void)
	Null constructor. More...
const string &	getName (void) const
	Returns the package name. More...
const PadArray &	getPads (void) const
	Returns a constant array of package pads. More...
PadIndex	findPadIndexByName (const string &inName) const
	Returns the pad index corresponding to the given pad name. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef xilinx::PadIndex	PadIndex
	Imported type name. More...
typedef std::map< std::string, PadIndex >	PadNameToPadIndexMap
	A map from pad names to pad indexes. More...

Protected Member Functions
	Package (const string &inName)
	Protected constructor. More...
PadArray &	getPads (void)
	Returns a non-constant array of package pads. More...

Protected Attributes
string	mName
	The package name. More...
PadArray	mPads
	The array of pads for this package. More...
PadNameToPadIndexMap	mPadNameToPadIndex
	The map from pad names to corresponding map indexes. More...

Friends
class	Sites
	The Sites class has access to our internals. More...
class	torc::architecture::architecture::PackageUnitTest
	Our unit test class has access to our internals. More...

Detailed Description

Encapsulation of a physical device package and its pins.

Definition at line 33 of file Package.hpp.

Member Typedef Documentation

typedef xilinx::PadIndex torc::architecture::Package::PadIndex

protected

Imported type name.

Definition at line 42 of file Package.hpp.

typedef std::map<std::string, PadIndex> torc::architecture::Package::PadNameToPadIndexMap

protected

A map from pad names to pad indexes.

Definition at line 44 of file Package.hpp.

typedef std::string torc::architecture::Package::string

protected

Imported type name.

Definition at line 41 of file Package.hpp.

Constructor & Destructor Documentation

torc::architecture::Package::Package ( const string &  inName )

inlineprotected

Protected constructor.

Definition at line 54 of file Package.hpp.

: mName(inName), mPads() {}

torc::architecture::Package::Package ( void  )

inline

Null constructor.

Definition at line 61 of file Package.hpp.

: mName(), mPads() {}

Member Function Documentation

PadIndex torc::architecture::Package::findPadIndexByName ( const string &  inName ) const

inline

Returns the pad index corresponding to the given pad name.

Definition at line 69 of file Package.hpp.

                                                                {
            PadNameToPadIndexMap::const_iterator p = mPadNameToPadIndex.find(inName);
            return (p == mPadNameToPadIndex.end()) ? PadIndex(-1) : p->second;
        }

Here is the caller graph for this function:

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

inline

Returns the package name.

Definition at line 64 of file Package.hpp.

{ return mName; }

Here is the caller graph for this function:

PadArray& torc::architecture::Package::getPads ( void  )

inlineprotected

Returns a non-constant array of package pads.

Definition at line 57 of file Package.hpp.

{ return mPads; }

Here is the caller graph for this function:

const PadArray& torc::architecture::Package::getPads ( void  ) const

inline

Returns a constant array of package pads.

Definition at line 66 of file Package.hpp.

{ return mPads; }

Friends And Related Function Documentation

friend class Sites

friend

The Sites class has access to our internals.

Definition at line 37 of file Package.hpp.

friend class torc::architecture::architecture::PackageUnitTest

friend

Our unit test class has access to our internals.

Definition at line 39 of file Package.hpp.

Field Documentation

string torc::architecture::Package::mName

protected

The package name.

Definition at line 47 of file Package.hpp.

PadNameToPadIndexMap torc::architecture::Package::mPadNameToPadIndex

protected

The map from pad names to corresponding map indexes.

Definition at line 51 of file Package.hpp.

PadArray torc::architecture::Package::mPads

protected

The array of pads for this package.

Definition at line 49 of file Package.hpp.

---

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

• Package.hpp