Represents an ordered list of port references. More...

#include <PortList.hpp>

Inheritance diagram for torc::generic::PortList:

Collaboration diagram for torc::generic::PortList:

Data Structures
class	Factory

Public Types
typedef PortElement	PortListElement

typedef VisitorType< PortList >	Visitor

typedef std::list < NetSharedPtr >::iterator	Connection

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Connected

typedef boost::signals2::signal< void(const NetSharedPtr &)>	Disconnected

typedef PortList	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

virtual Connection	connect (const NetSharedPtr &inNet) throw (Error)

virtual void	disconnect (const Connection &inConnection) throw (Error)

size_t	getSize () const

void	addChildPort (const PortSharedPtr &inPort)

void	addChildPortReference (const PortReferenceSharedPtr &inPortRef)

void	getChildren (std::list< PortListElement > &outPorts)

virtual	~PortList () throw ()

Connected &	signalNetConnected ()

Disconnected &	signalNetDisconnected ()

virtual void	getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error)

void	disconnect (const std::string &inName) throw (Error)

void	disconnect (const NetSharedPtr &net) throw (Error)

virtual void	disconnect () throw (Error)

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

Protected Member Functions
	PortList ()

virtual void	onConnect () throw (Error)

virtual void	onDisconnect () throw (Error)

Private Member Functions
template<typename _Tp >
void	connectElementToNet (const NetSharedPtr &inNet, const boost::shared_ptr< _Tp > &inType, size_t &inoutCurrentWidth) throw (Error)

Private Attributes
std::list< PortListElement >	mElements

Friends
class	FactoryType< PortList >

Detailed Description

Represents an ordered list of port references.

The PortList class represents an ordered list of port references. Such objects in EDIF are declard using the (portList portRefName1 portRefName2 ... ) syntax.

Definition at line 43 of file PortList.hpp.

Member Typedef Documentation

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Connected

inherited

A signal to indicate that a new connection has been made

Definition at line 57 of file Connectable.hpp.

typedef std::list<NetSharedPtr>::iterator torc::generic::Connectable::Connection

inherited

A connection between a net and this object

Definition at line 52 of file Connectable.hpp.

typedef boost::signals2::signal<void(const NetSharedPtr&)> torc::generic::Connectable::Disconnected

inherited

A signal to indicate that a connection has been removed

Definition at line 62 of file Connectable.hpp.

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< PortList >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef PortElement torc::generic::PortList::PortListElement

Definition at line 51 of file PortList.hpp.

typedef PortList torc::generic::SelfReferencing< PortList >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<PortList> torc::generic::PortList::Visitor

Definition at line 53 of file PortList.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< PortList >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Constructor & Destructor Documentation

torc::generic::PortList::~PortList	(	)
throw	(
	)

virtual

Definition at line 217 of file PortList.cpp.

                              {
     mElements.clear();
 }

torc::generic::PortList::PortList ( )

protected

Definition at line 215 of file PortList.cpp.

215 : Connectable(), mElements() {}

torc::generic::Connectable::Connectable

Connectable()

Definition: Connectable.cpp:151

torc::generic::PortList::mElements

std::list< PortListElement > mElements

Definition: PortList.hpp:145

Member Function Documentation

void torc::generic::PortList::accept	(	BaseVisitor &	inoutVisitor	)
throw	(	Error
	)

virtual

Receive a visitor to this class. The visit method of the visitor 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 situation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

Parameters

[in,out] inoutVisitor A reference to the visitor object

Exceptions

Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Definition at line 65 of file PortList.cpp.

                                                              {
     try {
         runVisitor(*this, inoutVisitor);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::PortList::addChildPort ( const PortSharedPtr & inPort )

Add a port to the port list.

Parameters

[in] inPort Pointer to port to be added.

Definition at line 203 of file PortList.cpp.

                                                        {
     mElements.push_back(PortListElement(inPort));
 }

void torc::generic::PortList::addChildPortReference ( const PortReferenceSharedPtr & inPortRef )

Add a port reference to the port list.

Parameters

[in] inPortRef Pointer to port reference to be added.

Definition at line 207 of file PortList.cpp.

                                                                             {
     mElements.push_back(PortListElement(inPortRef));
 }

Connectable::Connection torc::generic::PortList::connect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

virtual

Connect a Net to this object.

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.

Implements torc::generic::Connectable.

Definition at line 140 of file PortList.cpp.

                                                                                {
     size_t count = 0;
     for(std::list<PortListElement>::iterator it = mElements.begin(); it != mElements.end(); ++it) {
         try {
             switch((*it).getType()) {
             case PortListElement::eElementTypePort: {
                 connectElementToNet(inNet, (*it).getPort(), count);
                 break;
             }
             case PortListElement::eElementTypePortReference: {
                 connectElementToNet(inNet, (*it).getPortReference(), count);
                 break;
             }
             }
         } catch(Error& e) {
             e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
             throw;
         }
     }
     Connectable::Connection newConnection;
     try {
         ConnectionHandler handler(inNet);
         handler.connectPortListToNet(getSharedThis());
         newConnection = Connectable::connect(inNet);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
     return newConnection;
 }

Here is the call graph for this function:

template<typename _Tp >

void torc::generic::PortList::connectElementToNet	(	const NetSharedPtr &	inNet,
		const boost::shared_ptr< _Tp > &	inType,
		size_t &	inoutCurrentWidth
	)
throw	(	Error
	)

private

Definition at line 74 of file PortList.cpp.

                                                                                  {
     try {
         typedef _Tp Type;
         typedef boost::shared_ptr<_Tp> Pointer;
         size_t updatedSize = inoutCurrentWidth + inType->getSize();
         if(updatedSize > inNet->getSize()) {
             //TBD::ERROR
         }
         //Element can be connected to scalar or Vector only
         switch(inNet->getCompositionType()) {
         case eCompositionTypeScalar:
         case eCompositionTypeVectorBit: {
             if(1 == inType->getSize()) {
                 Connectable::Connection conn = inType->connect(inNet);
                 inoutCurrentWidth++;
                 (void) conn; // NJS
             }
             break;
         }
         case eCompositionTypeVector: {
             //We explode the vector net
             std::vector<NetSharedPtr> children;
             inNet->getChildren(children);
 
             switch(inType->getCompositionType()) {
             case eCompositionTypeScalar:
             case eCompositionTypeVectorBit:
                 //One element vector net to a scalar port
             {
                 connectElementToNet(children[inoutCurrentWidth], inType, inoutCurrentWidth);
                 break;
             }
             case eCompositionTypeVector:
                 //Part of vector net to vector port
             {
                 std::vector<Pointer> cTypes;
                 inType->getChildren(cTypes);
                 size_t j = 0;
                 for(size_t i = inoutCurrentWidth; i < updatedSize; i++, j++) {
                     connectElementToNet(children[i], cTypes[j], inoutCurrentWidth);
                 }
                 break;
             }
             case eCompositionTypeBundle: {
                 std::vector<Pointer> cTypes;
                 inType->getChildren(cTypes);
                 for(typename std::vector<Pointer>::iterator it = cTypes.begin(); it != cTypes.end();
                     ++it) {
                     connectElementToNet(inNet, *it, inoutCurrentWidth);
                 }
                 break;
             }
             }
         }
         case eCompositionTypeBundle:
         default: {
             //NOT POSSIBLE
         }
         }
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::PortList::disconnect	(	const Connection &	inConnection	)
throw	(	Error
	)

virtual

Disconnect a Net from this object.

Parameters

[in] inConnection A connection as returned by the connect() method

Exceptions

Error Provided connection is invalid

Implements torc::generic::Connectable.

Definition at line 171 of file PortList.cpp.

                                                                                  {
     NetSharedPtr inNet = *inConnection;
     //Do not clear components from here ...
     //They are connected to individual bits of some net
     // and would be cleared in due course
     try {
         ConnectionHandler handler(inNet);
         handler.disconnectPortListFromNet(getSharedThis());
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const std::string &	inName	)
throw	(	Error
	)

inherited

Disconnect the named 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] inName Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Disconnect the named 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] inNname Name of the net to be Disconnected

Exceptions

Error Provided net was not found

Definition at line 111 of file Connectable.cpp.

                                                                   {
     disconnect(std::find_if(mConnectedNets.begin(), mConnectedNets.end(),
         boost::bind<bool>(std::equal_to<std::string>(),
         boost::bind(boost::mem_fn(&Net::getName), _1), inName)));
 }

Here is the call graph for this function:

void torc::generic::Connectable::disconnect	(	const NetSharedPtr &	inNet	)
throw	(	Error
	)

inherited

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] net Pointer to a net

Exceptions

Error Provided net was not found

Disconnect the given Net from this object.

Note: This metod can be overridden by derived classes. However, the method must call the on_disconnected() method after this. The sigDisconnected_ signal must also be invoked in the overriding method.

Parameters

[in] inNet Pointer to a net

Exceptions

Error Provided net was not found

Definition at line 128 of file Connectable.cpp.

                                                                     {
     disconnect(std::find(mConnectedNets.begin(), mConnectedNets.end(), inNet));
 }

void torc::generic::Connectable::disconnect	(		)
throw	(	Error
	)

virtualinherited

Disconnect all connections to this port.

Reimplemented in torc::generic::Net, torc::generic::VectorNet, and torc::generic::NetBundle.

Definition at line 132 of file Connectable.cpp.

                                            {
     log("Disconnecting all\n");
     std::vector<NetSharedPtr> nets;
     getConnectedNets(nets, true);
     for(std::vector<NetSharedPtr>::iterator it = nets.begin(); it != nets.end(); ++it) {
         disconnect(*it);
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::generic::PortList::getChildren ( std::list< PortListElement > & outPorts )

Get all the children of this composition

Returns: [out] outPorts List containing all children

Definition at line 211 of file PortList.cpp.

                                                                 {
     outElements.insert(outElements.end(), mElements.begin(), mElements.end());
 }

void torc::generic::Connectable::getConnectedNets	(	std::vector< NetSharedPtr > &	outNets,
		bool	inSkipChildConnections = `false`
	)		const
throw	(	Error
	)

virtualinherited

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 in torc::generic::VectorPortReference, torc::generic::VectorNet, torc::generic::VectorPort, torc::generic::VectorNetBit, torc::generic::VectorPortBit, and torc::generic::VectorPortBitReference.

Definition at line 45 of file Connectable.cpp.

                         {
     outNets.insert(outNets.end(), mConnectedNets.begin(), mConnectedNets.end());
 }

Here is the caller graph for this function:

Pointer torc::generic::SelfReferencing< PortList >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns: A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out] ptr Set to a shared pointer to this object

size_t torc::generic::PortList::getSize ( void ) const

Get the total number of bits of the composition

Returns: Number of bits

Definition at line 185 of file PortList.cpp.

                                {
     size_t size = 0;
     for(std::list<PortListElement>::const_iterator it = mElements.begin(); it != mElements.end();
         ++it) {
         switch((*it).getType()) {
         case PortListElement::eElementTypePort: {
             size += (*it).getPort()->getSize();
             break;
         }
         case PortListElement::eElementTypePortReference: {
             size += (*it).getPortReference()->getSize();
             break;
         }
         }
     }
     return size;
 }

Here is the caller graph for this function:

void torc::generic::Connectable::onConnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Connected to this object

Definition at line 144 of file Connectable.cpp.

144 {}

void torc::generic::Connectable::onDisconnect	(		)
throw	(	Error
	)

protectedvirtualinherited

A polymorphic function that is called after a net is Disconnected from this object

Definition at line 149 of file Connectable.cpp.

149 {}

void torc::generic::SelfReferencing< PortList >::setWeakThis ( const WeakPointer & inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in] weakThis A weak pointer to this object

Connectable::Connected & torc::generic::Connectable::signalNetConnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 167 of file Connectable.hpp.

                                                              {
     return mSigNetConnected;
 }

Connectable::Disconnected & torc::generic::Connectable::signalNetDisconnected ( )

inlineinherited

A signal to indicate that a new connection has been made

Definition at line 174 of file Connectable.hpp.

                                                                    {
     return mSigNetDisconnected;
 }

Friends And Related Function Documentation

friend class FactoryType< PortList >

friend

Definition at line 48 of file PortList.hpp.

Field Documentation

std::list<PortListElement> torc::generic::PortList::mElements

private

Definition at line 145 of file PortList.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation