torc::architecture::Arc Class Reference

Encapsulation of an arc between two tilewires. More...

#include <Arc.hpp>

Collaboration diagram for torc::architecture::Arc:

[legend]

List of all members.

Public Member Functions
	Arc (void)
	Null constructor.
	Arc (const Tilewire &inSourceTilewire, const Tilewire &inSinkTilewire)
	Public constructor.
const Tilewire &	getSourceTilewire (void) const
	Returns the source tilewire.
const Tilewire &	getSinkTilewire (void) const
	Returns the sink tilewire.
bool	operator== (const Arc &rhs) const
	Comparison operator.
bool	isUndefined (void) const
Protected Attributes
Tilewire	mSourceTilewire
	The source tilewire.
Tilewire	mSinkTilewire
	The sink tilewire.
Friends
std::size_t	hash_value (const Arc &inArc)
	Return a hash value for the specified arc.

---

Detailed Description

Encapsulation of an arc between two tilewires.

Definition at line 28 of file Arc.hpp.

---

Constructor & Destructor Documentation

torc::architecture::Arc::Arc

(

void

)

[inline]

Null constructor.

The source and sink tilewires will be set to Tilewire::sInvalid.

Definition at line 39 of file Arc.hpp.

torc::architecture::Arc::Arc	(	const Tilewire &	inSourceTilewire,
		const Tilewire &	inSinkTilewire
	)			[inline]

Public constructor.

Definition at line 41 of file Arc.hpp.

---

Member Function Documentation

const Tilewire& torc::architecture::Arc::getSourceTilewire

(

void

)

const [inline]

Returns the source tilewire.

Definition at line 45 of file Arc.hpp.

const Tilewire& torc::architecture::Arc::getSinkTilewire

(

void

)

const [inline]

Returns the sink tilewire.

Definition at line 47 of file Arc.hpp.

bool torc::architecture::Arc::operator==

(

const Arc &

rhs

)

const [inline]

Comparison operator.

Definition at line 50 of file Arc.hpp.

---

Friends And Related Function Documentation

std::size_t hash_value

(

const Arc &

inArc

)

[friend]

Return a hash value for the specified arc.

Definition at line 25 of file Arc.cpp.

---

Member Data Documentation

Tilewire torc::architecture::Arc::mSourceTilewire [protected]

The source tilewire.

Definition at line 32 of file Arc.hpp.

Tilewire torc::architecture::Arc::mSinkTilewire [protected]

The sink tilewire.

Definition at line 34 of file Arc.hpp.

---

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

• torc/architecture/Arc.hpp