torc::architecture::PrimitivePin Class Reference

Encapsulation of a primitive pin's name and flags. Primitive pins are logic site inputs or outputs. More...

#include <PrimitivePin.hpp>

Inheritance diagram for torc::architecture::PrimitivePin:

[legend]

Collaboration diagram for torc::architecture::PrimitivePin:

[legend]

List of all members.

Public Member Functions
const string &	getName (void) const
	Returns the pin name.
PinFlags	getFlags (void) const
	Returns the pin direction flags.
	PrimitivePin (void)
	Null constructor. This constructor should only be used by containers.
bool	isInput (void) const
	Returns true if this pin is a primitive input.
bool	isOutput (void) const
	Returns true if this pin is a primitive output.
Protected Types
typedef xilinx::PinFlags	PinFlags
	Imported type name.
typedef std::string	string
	Imported type name.
Protected Member Functions
	PrimitivePin (const string &inName, PinFlags inFlags)
	Protected constructor. inName The pin name. inFlags The pin direction flags.
Protected Attributes
string	mName
	The pin name.
PinFlags	mFlags
	The pin direction flags.
Friends
class	Sites
	The Sites class has access to our internals.
class	torc::architecture::architecture::PrimitivePinUnitTest
	Our unit test class has access to our internals.

---

Detailed Description

Encapsulation of a primitive pin's name and flags. Primitive pins are logic site inputs or outputs.

Definition at line 43 of file PrimitivePin.hpp.

---

Member Typedef Documentation

typedef xilinx::PinFlags torc::architecture::PrimitivePin::PinFlags [protected]

Imported type name.

Definition at line 51 of file PrimitivePin.hpp.

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

Imported type name.

Definition at line 52 of file PrimitivePin.hpp.

---

Constructor & Destructor Documentation

torc::architecture::PrimitivePin::PrimitivePin	(	const string &	inName,
		PinFlags	inFlags
	)			[inline, protected]

Protected constructor. inName The pin name. inFlags The pin direction flags.

Definition at line 63 of file PrimitivePin.hpp.

torc::architecture::PrimitivePin::PrimitivePin

(

void

)

[inline]

Null constructor. This constructor should only be used by containers.

Definition at line 73 of file PrimitivePin.hpp.

---

Member Function Documentation

const string& torc::architecture::PrimitivePin::getName

(

void

)

const [inline]

Returns the pin name.

Definition at line 68 of file PrimitivePin.hpp.

PinFlags torc::architecture::PrimitivePin::getFlags

(

void

)

const [inline]

Returns the pin direction flags.

Definition at line 70 of file PrimitivePin.hpp.

bool torc::architecture::PrimitivePin::isInput

(

void

)

const [inline]

Returns true if this pin is a primitive input.

Definition at line 75 of file PrimitivePin.hpp.

bool torc::architecture::PrimitivePin::isOutput

(

void

)

const [inline]

Returns true if this pin is a primitive output.

Definition at line 77 of file PrimitivePin.hpp.

---

Friends And Related Function Documentation

friend class Sites [friend]

The Sites class has access to our internals.

Definition at line 47 of file PrimitivePin.hpp.

friend class torc::architecture::architecture::PrimitivePinUnitTest [friend]

Our unit test class has access to our internals.

Definition at line 49 of file PrimitivePin.hpp.

---

Member Data Documentation

string torc::architecture::PrimitivePin::mName [protected]

The pin name.

Definition at line 55 of file PrimitivePin.hpp.

PinFlags torc::architecture::PrimitivePin::mFlags [protected]

The pin direction flags.

See also:

PinDirection.

Definition at line 58 of file PrimitivePin.hpp.

---

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

• torc/architecture/PrimitivePin.hpp