torc::physical::Port Class Reference

Module input or output port. More...

#include <Port.hpp>

Inheritance diagram for torc::physical::Port:

[legend]

Collaboration diagram for torc::physical::Port:

[legend]

List of all members.

Public Member Functions
const InstanceWeakPtr &	getInstancePtr (void) const
	Returns a weak instance pointer.
const PinName &	getPinName (void) const
	Returns the pin name.
bool	operator== (const Port &rhs) const
	Equality operator.
Protected Types
typedef std::string	string
	Imported type name.
Protected Member Functions
	Port (const string &inName, InstanceSharedPtr inInstancePtr, const string &inPinName)
	Protected constructor.
Protected Attributes
InstanceWeakPtr	mInstancePtr
	The port instance pointer.
PinName	mPinName
	The port pin name.
Friends
class	Factory
	The Factory class has direct access to our internals.

---

Detailed Description

Module input or output port.

This class declares a named port for the enclosing module.

Definition at line 37 of file Port.hpp.

---

Member Typedef Documentation

typedef std::string torc::physical::Port::string [protected]

Imported type name.

Reimplemented from torc::physical::Named.

Definition at line 44 of file Port.hpp.

---

Constructor & Destructor Documentation

torc::physical::Port::Port	(	const string &	inName,
		InstanceSharedPtr	inInstancePtr,
		const string &	inPinName
	)			[inline, protected]

Protected constructor.

Parameters:

	inName	The port name.
	inInstancePtr	The port instance pointer.
	inPinName	The port pin name.

Definition at line 55 of file Port.hpp.

---

Member Function Documentation

const InstanceWeakPtr& torc::physical::Port::getInstancePtr

(

void

)

const [inline]

Returns a weak instance pointer.

Definition at line 60 of file Port.hpp.

const PinName& torc::physical::Port::getPinName

(

void

)

const [inline]

Returns the pin name.

Definition at line 62 of file Port.hpp.

bool torc::physical::Port::operator==

(

const Port &

rhs

)

const [inline]

Equality operator.

This function deems ports equal if their names are identical.

Returns:

true if both port names are identical, or false otherwise.

Definition at line 67 of file Port.hpp.

---

Friends And Related Function Documentation

friend class Factory [friend]

The Factory class has direct access to our internals.

Definition at line 40 of file Port.hpp.

---

Member Data Documentation

InstanceWeakPtr torc::physical::Port::mInstancePtr [protected]

The port instance pointer.

Definition at line 47 of file Port.hpp.

PinName torc::physical::Port::mPinName [protected]

The port pin name.

Definition at line 49 of file Port.hpp.

---

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

• torc/physical/Port.hpp