torc::architecture::Site Class Reference

Encapsulation of a device logic site. More...

#include <Site.hpp>

Collaboration diagram for torc::architecture::Site:

Collaboration graph
[legend]

List of all members.

Public Types

typedef Array< const WireIndexWireIndexArray
 Array of constant wire indexes.

Public Member Functions

 Site (void)
 Null constructor (for use in containers only).
const Tilewire getPinTilewire (const std::string &inName) const
 Returns the Tilewire associated with the specified pin name.
const stringgetName (void) const
 Returns the site name.
const PrimitiveDefgetPrimitiveDefPtr (void) const
 Returns a pointer to the associated primitive definition.
TileIndex getTileIndex (void) const
 Returns the index of the containing tile.
SiteFlags getFlags (void) const
 Returns the flags associated with this site.
const WireIndexArraygetPinMapPtr (void) const
 Returns the pin to wire map for this site.

Protected Types

typedef std::string string
 Imported type name.
typedef xilinx::PinIndex PinIndex
 Imported type name.
typedef xilinx::TileIndex TileIndex
 Imported type name.
typedef xilinx::WireIndex WireIndex
 Imported type name.
typedef xilinx::SiteFlags SiteFlags
 Imported type name.

Protected Member Functions

 Site (const string &inName, const PrimitiveDef &inPrimitiveDef, TileIndex inTileIndex, SiteFlags inFlags, const WireIndexArray &inPinMap)
 Protected constructor.

Protected Attributes

string mName
 The logic site name.
const PrimitiveDefmPrimitiveDefPtr
 Pointer to the associated primitive definition.
TileIndex mTileIndex
 The index of the containing tile.
SiteFlags mFlags
 The flags associated with this site.
const WireIndexArraymPinMapPtr
 The pin to wire map for this site.

Friends

class Sites
 The Sites class has access to our internals.


Detailed Description

Encapsulation of a device logic site.

Definition at line 30 of file Site.hpp.


Member Typedef Documentation

typedef std::string torc::architecture::Site::string [protected]

Imported type name.

Definition at line 36 of file Site.hpp.

Imported type name.

Definition at line 37 of file Site.hpp.

Imported type name.

Definition at line 38 of file Site.hpp.

Imported type name.

Definition at line 39 of file Site.hpp.

Imported type name.

Definition at line 40 of file Site.hpp.

Array of constant wire indexes.

Definition at line 44 of file Site.hpp.


Constructor & Destructor Documentation

torc::architecture::Site::Site ( const string inName,
const PrimitiveDef inPrimitiveDef,
TileIndex  inTileIndex,
SiteFlags  inFlags,
const WireIndexArray inPinMap 
) [inline, protected]

Protected constructor.

Definition at line 59 of file Site.hpp.

torc::architecture::Site::Site ( void   )  [inline]

Null constructor (for use in containers only).

Definition at line 67 of file Site.hpp.


Member Function Documentation

const Tilewire torc::architecture::Site::getPinTilewire ( const std::string &  inName  )  const [inline]

Returns the Tilewire associated with the specified pin name.

Definition at line 70 of file Site.hpp.

const string& torc::architecture::Site::getName ( void   )  const [inline]

Returns the site name.

Definition at line 79 of file Site.hpp.

const PrimitiveDef* torc::architecture::Site::getPrimitiveDefPtr ( void   )  const [inline]

Returns a pointer to the associated primitive definition.

Definition at line 81 of file Site.hpp.

TileIndex torc::architecture::Site::getTileIndex ( void   )  const [inline]

Returns the index of the containing tile.

Definition at line 83 of file Site.hpp.

SiteFlags torc::architecture::Site::getFlags ( void   )  const [inline]

Returns the flags associated with this site.

Definition at line 85 of file Site.hpp.

const WireIndexArray* torc::architecture::Site::getPinMapPtr ( void   )  const [inline]

Returns the pin to wire map for this site.

Definition at line 87 of file Site.hpp.


Friends And Related Function Documentation

friend class Sites [friend]

The Sites class has access to our internals.

Definition at line 34 of file Site.hpp.


Member Data Documentation

The logic site name.

Definition at line 48 of file Site.hpp.

Pointer to the associated primitive definition.

Definition at line 50 of file Site.hpp.

The index of the containing tile.

Definition at line 52 of file Site.hpp.

The flags associated with this site.

Definition at line 54 of file Site.hpp.

The pin to wire map for this site.

Definition at line 56 of file Site.hpp.


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

Generated on Thu Oct 13 16:49:36 2011 for TORC by  doxygen 1.5.6