torc::architecture::Tilewire Class Reference

Encapsulation of a device tile and wire pair. More...

#include <Tilewire.hpp>

Inheritance diagram for torc::architecture::Tilewire:

[legend]

Collaboration diagram for torc::architecture::Tilewire:

[legend]

List of all members.

Public Member Functions
	Tilewire (void)
	Null constructor.
	Tilewire (const TileIndex &inTileIndex, const WireIndex &inWireIndex)
	Public constructor.
	Tilewire (const Tilewire &inTilewire)
	Copy constructor.
const TileIndex &	getTileIndex (void) const
	Returns the tile index.
const WireIndex &	getWireIndex (void) const
	Returns the wire index.
void	setTileIndex (const TileIndex &inTileIndex)
	Sets the tile index.
void	setWireIndex (const WireIndex &inWireIndex)
	Sets the wire index.
bool	operator== (const Tilewire &rhs) const
	Equality operator.
const Tilewire &	operator= (const Tilewire &rhs)
	Assignment operator.
bool	operator< (const Tilewire &rhs) const
	Comparison operator.
bool	isUndefined (void) const
Static Public Attributes
static const Tilewire	sInvalid = Tilewire(TileIndex(-1), WireIndex(-1))
Protected Types
typedef xilinx::TileIndex	TileIndex
	Imported type name.
typedef xilinx::WireIndex	WireIndex
	Imported type name.
Protected Attributes
TileIndex	mTileIndex
	The tile index.
WireIndex	mWireIndex
	The wire index.
Friends
std::size_t	hash_value (const Tilewire &inTilewire)
	Return a hash value for the specified tilewire.

---

Detailed Description

Encapsulation of a device tile and wire pair.

Definition at line 39 of file Tilewire.hpp.

---

Member Typedef Documentation

typedef xilinx::TileIndex torc::architecture::Tilewire::TileIndex [protected]

Imported type name.

Definition at line 43 of file Tilewire.hpp.

typedef xilinx::WireIndex torc::architecture::Tilewire::WireIndex [protected]

Imported type name.

Definition at line 45 of file Tilewire.hpp.

---

Constructor & Destructor Documentation

torc::architecture::Tilewire::Tilewire

(

void

)

[inline]

Null constructor.

The tilewire will be set to Tilewire::sInvalid.

Definition at line 55 of file Tilewire.hpp.

torc::architecture::Tilewire::Tilewire	(	const TileIndex &	inTileIndex,
		const WireIndex &	inWireIndex
	)			[inline]

Public constructor.

Definition at line 57 of file Tilewire.hpp.

torc::architecture::Tilewire::Tilewire

(

const Tilewire &

inTilewire

)

[inline]

Copy constructor.

Definition at line 60 of file Tilewire.hpp.

---

Member Function Documentation

const TileIndex& torc::architecture::Tilewire::getTileIndex

(

void

)

const [inline]

Returns the tile index.

Definition at line 64 of file Tilewire.hpp.

const WireIndex& torc::architecture::Tilewire::getWireIndex

(

void

)

const [inline]

Returns the wire index.

Definition at line 66 of file Tilewire.hpp.

void torc::architecture::Tilewire::setTileIndex

(

const TileIndex &

inTileIndex

)

[inline]

Sets the tile index.

Definition at line 68 of file Tilewire.hpp.

void torc::architecture::Tilewire::setWireIndex

(

const WireIndex &

inWireIndex

)

[inline]

Sets the wire index.

Definition at line 70 of file Tilewire.hpp.

bool torc::architecture::Tilewire::operator==

(

const Tilewire &

rhs

)

const [inline]

Equality operator.

Definition at line 73 of file Tilewire.hpp.

const Tilewire& torc::architecture::Tilewire::operator=

(

const Tilewire &

rhs

)

[inline]

Assignment operator.

Definition at line 76 of file Tilewire.hpp.

bool torc::architecture::Tilewire::operator<

(

const Tilewire &

rhs

)

const [inline]

Comparison operator.

This operator facilitates ordering in containers.

Definition at line 80 of file Tilewire.hpp.

---

Friends And Related Function Documentation

std::size_t hash_value

(

const Tilewire &

inTilewire

)

[friend]

Return a hash value for the specified tilewire.

Definition at line 27 of file Tilewire.cpp.

---

Member Data Documentation

TileIndex torc::architecture::Tilewire::mTileIndex [protected]

The tile index.

Definition at line 48 of file Tilewire.hpp.

WireIndex torc::architecture::Tilewire::mWireIndex [protected]

The wire index.

Definition at line 50 of file Tilewire.hpp.

---

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

• torc/architecture/Tilewire.hpp
• torc/architecture/Tilewire.cpp