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

Encapsulation of the site index, pin name, and pin flags for a package. More...

#include <Pad.hpp>

+ Collaboration diagram for torc::architecture::Pad:

Public Member Functions

 Pad (void)
 Null constructor. More...
 
SiteIndex getSiteIndex (void) const
 Returns the index of the site corresponding to this pad. More...
 
const stringgetName (void) const
 Returns the name of the pad in its physical package. More...
 
SiteFlags getFlags (void) const
 Returns the site flags for this pad, specifically including bonding. More...
 

Protected Types

typedef std::string string
 Imported type name. More...
 
typedef xilinx::SiteIndex SiteIndex
 Imported type name. More...
 
typedef xilinx::SiteFlags SiteFlags
 Imported type name. More...
 

Protected Member Functions

 Pad (SiteIndex inSiteIndex, const string &inName, SiteFlags inFlags)
 Protected constructor. More...
 

Protected Attributes

SiteIndex mSiteIndex
 The index of the site corresponding to this pad. More...
 
string mName
 The name of the pad in its physical package. More...
 
SiteFlags mFlags
 The site flags for this pad, specifically including bonding. More...
 

Friends

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

Detailed Description

Encapsulation of the site index, pin name, and pin flags for a package.

Definition at line 33 of file Pad.hpp.

Member Typedef Documentation

Imported type name.

Definition at line 44 of file Pad.hpp.

Imported type name.

Definition at line 43 of file Pad.hpp.

typedef std::string torc::architecture::Pad::string
protected

Imported type name.

Definition at line 42 of file Pad.hpp.

Constructor & Destructor Documentation

torc::architecture::Pad::Pad ( SiteIndex  inSiteIndex,
const string inName,
SiteFlags  inFlags 
)
inlineprotected

Protected constructor.

Definition at line 54 of file Pad.hpp.

55  : mSiteIndex(inSiteIndex), mName(inName), mFlags(inFlags) {}
SiteIndex mSiteIndex
The index of the site corresponding to this pad.
Definition: Pad.hpp:47
string mName
The name of the pad in its physical package.
Definition: Pad.hpp:49
SiteFlags mFlags
The site flags for this pad, specifically including bonding.
Definition: Pad.hpp:51
torc::architecture::Pad::Pad ( void  )
inline

Null constructor.

Definition at line 59 of file Pad.hpp.

59 : mSiteIndex(), mName(), mFlags() {};
SiteIndex mSiteIndex
The index of the site corresponding to this pad.
Definition: Pad.hpp:47
string mName
The name of the pad in its physical package.
Definition: Pad.hpp:49
SiteFlags mFlags
The site flags for this pad, specifically including bonding.
Definition: Pad.hpp:51

Member Function Documentation

SiteFlags torc::architecture::Pad::getFlags ( void  ) const
inline

Returns the site flags for this pad, specifically including bonding.

Definition at line 66 of file Pad.hpp.

66 { return mFlags; }
SiteFlags mFlags
The site flags for this pad, specifically including bonding.
Definition: Pad.hpp:51

+ Here is the caller graph for this function:

const string& torc::architecture::Pad::getName ( void  ) const
inline

Returns the name of the pad in its physical package.

Definition at line 64 of file Pad.hpp.

64 { return mName; }
string mName
The name of the pad in its physical package.
Definition: Pad.hpp:49

+ Here is the caller graph for this function:

SiteIndex torc::architecture::Pad::getSiteIndex ( void  ) const
inline

Returns the index of the site corresponding to this pad.

Definition at line 62 of file Pad.hpp.

62 { return mSiteIndex; }
SiteIndex mSiteIndex
The index of the site corresponding to this pad.
Definition: Pad.hpp:47

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class Sites
friend

The Sites class has access to our internals.

Definition at line 36 of file Pad.hpp.

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

The Package unit test class has access to our internals.

Definition at line 40 of file Pad.hpp.

friend class torc::architecture::architecture::PadUnitTest
friend

Our unit test class has access to our internals.

Definition at line 38 of file Pad.hpp.

Field Documentation

SiteFlags torc::architecture::Pad::mFlags
protected

The site flags for this pad, specifically including bonding.

Definition at line 51 of file Pad.hpp.

string torc::architecture::Pad::mName
protected

The name of the pad in its physical package.

Definition at line 49 of file Pad.hpp.

SiteIndex torc::architecture::Pad::mSiteIndex
protected

The index of the site corresponding to this pad.

Definition at line 47 of file Pad.hpp.


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