torc::generic::VectorPortReference Class Reference

Represents a reference to a port array. More...

#include <VectorPortReference.hpp>

Inheritance diagram for torc::generic::VectorPortReference:

Inheritance graph
[legend]
Collaboration diagram for torc::generic::VectorPortReference:

Collaboration graph
[legend]

List of all members.

Public Types

typedef Vector< PortReference,
VectorPortBitReference,
VectorPortBitReference::Factory,
true > 		BaseType
typedef VisitorType
< VectorPortReference > 		Visitor

Public Member Functions

virtual void accept (BaseVisitor &inoutVisitor) throw (Error)
virtual void setParent (const InstanceSharedPtr &inParent) throw ()
virtual Connectable::Connection connect (const NetSharedPtr &inNet) throw (Error)
void disconnect (const Connectable::Connection &inConnection) throw (Error)
virtual void getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error)
virtual void onChildCreate (const VectorPortBitReferenceSharedPtr &inCreatedChild) const throw (Error)
virtual void bindToMasterPort (const PortSharedPtr &inMaster) throw (Error)

Friends

class FactoryType< VectorPortReference >

Classes

class  Factory

Detailed Description

Represents a reference to a port array.

The VectorPortReference class represents a reference to a port array.

Definition at line 47 of file VectorPortReference.hpp.

Member Function Documentation

void torc::generic::VectorPortReference::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 154 of file VectorPortReference.cpp.

Connectable::Connection torc::generic::VectorPortReference::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.
Exceptions:
Error Pointer to the Net object does not exist
  • Id : eMessageIdErrorPointerToItemDoesNotExist
  • Context Data
    • Pointer to the Net - boost::shared_ptr
Error Net size does not match with VectorPortReference size
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 eeds to be connected
Returns:
A connection that has been established. This can be used later for disconnection.
Exceptions:
Error Pointer to the Net object does not exist
Error Net size does not match with VectorPortReference size

Implements torc::generic::Connectable.

Definition at line 192 of file VectorPortReference.cpp.

void torc::generic::VectorPortReference::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, because pointer to the Net does not exist
  • Id : eMessageIdErrorPointerToItemDoesNotExist
  • Context Data
    • Pointer to Net - boost::shared_ptr
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] connection A connection as returned by the connect() method
Exceptions:
Error Provided connection is invalid

Implements torc::generic::Connectable.

Definition at line 233 of file VectorPortReference.cpp.

void torc::generic::VectorPortReference::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
Get the vector of Nets that are Connected to the current object. The connected elements are appended to the given vector

Returns:
A vector of Connected nets

Reimplemented from torc::generic::Connectable.

Definition at line 264 of file VectorPortReference.cpp.

void torc::generic::VectorPortReference::bindToMasterPort ( const PortSharedPtr &  inMaster  )  throw (Error) [virtual]

Set master port.

Parameters:
[in] inMaster Set the master port.
Set master port.

Parameters:
[in] inSource Set the master port.

Reimplemented from torc::generic::PortReference.

Definition at line 290 of file VectorPortReference.cpp.

The documentation for this class was generated from the following files:
Generated on Thu Oct 13 16:50:35 2011 for TORC by  doxygen 1.5.6