torc::generic::PortReference Class Reference
Represents the usable instance of a port of a cell in another cell. More...
#include <PortReference.hpp>
Public Member Functions | |
| PortSharedPtr | getMaster () const throw () |
| virtual void | bindToMasterPort (const PortSharedPtr &inMaster) throw (Error) |
| const PortAttributesSharedPtr | getAttributes () const throw () |
| void | setAttributes (const PortAttributesSharedPtr &inSource) throw () |
| std::string | getName () throw () |
Private Member Functions | |
| PortReference (const PortReference &source) | |
| PortReference & | operator= (const PortReference &source) throw () |
Private Attributes | |
| PortSharedPtr | mMaster |
| PortAttributesSharedPtr | mAttributes |
Detailed Description
Represents the usable instance of a port of a cell in another cell.The PortReference class is used to provide an interface for port usage of an instantiated cell. In other words, it more or less models the (portRef ...) keyword in EDIF. However, unlike a simple portRef, this can have properties that can be assigned to a portRef using (portInstance ...) syntax. This interface can be used to refer to all types of port references( scalar, vector, vector-bit and bundle).
Definition at line 46 of file PortReference.hpp.
Member Function Documentation
| PortSharedPtr torc::generic::PortReference::getMaster | ( | ) | const throw () [inline] |
Get the master(referred) port.
- Returns:
- The master port.
Definition at line 128 of file PortReference.hpp.
| void torc::generic::PortReference::bindToMasterPort | ( | const PortSharedPtr & | inMaster | ) | throw (Error) [virtual] |
Set master port.
- Parameters:
-
[in] inMaster Set the master port.
- Parameters:
-
[in] inSource Set the master port.
Reimplemented in torc::generic::PortBundleReference, and torc::generic::VectorPortReference.
Definition at line 58 of file PortReference.cpp.
| const PortAttributesSharedPtr torc::generic::PortReference::getAttributes | ( | ) | const throw () [inline] |
Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
- Returns:
- Pointer to PortAttributes object.
Definition at line 138 of file PortReference.hpp.
| void torc::generic::PortReference::setAttributes | ( | const PortAttributesSharedPtr & | inSource | ) | throw () |
Set the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
- Note:
- This method does not check whether prior set of properties exist or not. Newly set property will remove old properties.
- Parameters:
-
[in] inSource Pointer to PortAttributes object.
Definition at line 64 of file PortReference.cpp.
| std::string torc::generic::PortReference::getName | ( | void | ) | throw () |
Get name of port-ref. This will return the same name as the master.
- Returns:
- Name of the master if master is set. Otherwise returns empty string.
Definition at line 69 of file PortReference.cpp.
The documentation for this class was generated from the following files:
- torc/generic/om/PortReference.hpp
- torc/generic/om/PortReference.cpp
