torc::generic::VectorNet Class Reference
Represents a net array. More...
#include <VectorNet.hpp>
Public Types | |
|
typedef Vector< Net, VectorNetBit, VectorNetBit::Factory, true > | BaseVectorType |
| typedef VisitorType< VectorNet > | Visitor |
Public Member Functions | |
| virtual void | accept (BaseVisitor &inoutVisitor) throw (Error) |
| virtual void | setParent (const ViewSharedPtr &inParent) throw () |
| virtual Connectable::Connection | connect (const NetSharedPtr &inNet) throw (Error) |
| void | disconnect (const Connectable::Connection &inConnection) throw (Error) |
| void | disconnect () throw (Error) |
| virtual void | getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error) |
| virtual void | getConnectedPorts (std::vector< PortSharedPtr > &outPorts, bool inSkipChildConnections=false) const throw () |
| virtual void | getConnectedPortRefs (std::vector< PortReferenceSharedPtr > &outPortRefs, bool inSkipChildConnections=false) const throw () |
Protected Member Functions | |
| virtual void | onChildCreate (const boost::shared_ptr< BaseVectorType::ChildType > &inCreatedChild) const throw (Error) |
Friends | |
| class | FactoryType< VectorNet > |
Classes | |
| class | Factory |
Detailed Description
Represents a net array.The VectorNet class represents a net array. Such objects in EDIF are declard using the (net (array ...) ) syntax.
Definition at line 44 of file VectorNet.hpp.
Member Function Documentation
| void torc::generic::VectorNet::accept | ( | BaseVisitor & | inoutVisitor | ) | throw (Error) [virtual] |
Recive a inoutVisitor to this class. The visit method of the inoutVisitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.
- Parameters:
-
[in,out] inoutVisitor A reference to the inoutVisitor object
- Exceptions:
-
Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.
Implements torc::generic::Visitable.
Definition at line 118 of file VectorNet.cpp.
| Connectable::Connection torc::generic::VectorNet::connect | ( | const NetSharedPtr & | inNet | ) | throw (Error) [virtual] |
Connect a Net to this object.
- Note:
- This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.
- Parameters:
-
[in] inNet A pointer to the Net object that needs to be connected
- Returns:
- A connection that has been established. This can be used later for disconnection.
- Note:
- This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.
- Parameters:
-
[in] inNet A pointer to the Net object that eeds to be connected
- Returns:
- A connection that has been established. This can be used later for disconnection.
Implements torc::generic::Connectable.
Definition at line 151 of file VectorNet.cpp.
| void torc::generic::VectorNet::disconnect | ( | const Connectable::Connection & | inConnection | ) | throw (Error) [virtual] |
Disconnect a Net from this object.
- Note:
- This metod can be overridden by derived classes. However, the method must call the on_connected() method after this. The sigConnected_ signal must also be invoked in the overriding method.
- Parameters:
-
[in] inConnection A connection as returned by the connect() method
- Exceptions:
-
Error Provided connection is invalid
Implements torc::generic::Connectable.
Definition at line 179 of file VectorNet.cpp.
| void torc::generic::VectorNet::disconnect | ( | ) | throw (Error) [virtual] |
Disconnect all connections to this port.
Reimplemented from torc::generic::Net.
Definition at line 185 of file VectorNet.cpp.
| void torc::generic::VectorNet::getConnectedNets | ( | std::vector< NetSharedPtr > & | outNets, | |
| bool | inSkipChildConnections = false | |||
| ) | const throw (Error) [virtual] |
Get the vector of Nets that are Connected to the current object. The connected elements are appended to the given vector
- Parameters:
-
[out] outNets A vector of Connected nets
- Returns:
- A vector of Connected nets
Reimplemented from torc::generic::Connectable.
Definition at line 208 of file VectorNet.cpp.
| void torc::generic::VectorNet::getConnectedPorts | ( | std::vector< PortSharedPtr > & | outPort, | |
| bool | inSkipChildConnections = false | |||
| ) | const throw () [virtual] |
Appends vector of connected ports
- Parameters:
-
[in] outPort vector of port to be appended to [in] inSkipChildConnections Return only ports connected to this port and skip returning elements that have been connected to the child
Reimplemented from torc::generic::Net.
Definition at line 229 of file VectorNet.cpp.
| void torc::generic::VectorNet::getConnectedPortRefs | ( | std::vector< PortReferenceSharedPtr > & | outPortRefs, | |
| bool | inSkipChildConnections = false | |||
| ) | const throw () [virtual] |
Appends vector of connected port references
- Parameters:
-
[in] outPortRefs vector of port refs to be appended to
Reimplemented from torc::generic::Net.
Definition at line 249 of file VectorNet.cpp.
The documentation for this class was generated from the following files:
- torc/generic/om/VectorNet.hpp
- torc/generic/om/VectorNet.cpp
