torc::generic::Connectable Class Reference

An object that is connectable to a Net. More...

#include <Connectable.hpp>

Inheritance diagram for torc::generic::Connectable:

Public Types
typedef std::list < NetSharedPtr >::iterator	Connection
typedef boost::signals2::signal< void(const NetSharedPtr &)>	Connected
typedef boost::signals2::signal< void(const NetSharedPtr &)>	Disconnected

Public Member Functions
Connected &	signalNetConnected ()
Disconnected &	signalNetDisconnected ()
virtual void	getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error)
virtual Connection	connect (const NetSharedPtr &inNet)=0 throw (Error)
virtual void	disconnect (const Connection &inConnection)=0 throw (Error)
void	disconnect (const std::string &inName) throw (Error)
void	disconnect (const NetSharedPtr &net) throw (Error)
virtual void	disconnect () throw (Error)

Protected Member Functions
virtual void	onConnect () throw (Error)
virtual void	onDisconnect () throw (Error)
	Connectable ()
virtual	~Connectable () throw ()

Private Member Functions
	Connectable (const Connectable &rhs)
Connectable &	operator= (const Connectable &rhs)

Private Attributes
std::list< NetSharedPtr >	mConnectedNets
Connected	mSigNetConnected
Disconnected	mSigNetDisconnected

Detailed Description

An object that is connectable to a Net.

The Connectable class can act as a base for objects that can connect to a Net. This interface provides event functionality for connection and disconnection. It also provides polymorphic methods to implement connectivity beween different components in a design.

Definition at line 44 of file Connectable.hpp.

Member Typedef Documentation

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

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

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

A signal to indicate that a connection has been removed

Definition at line 62 of file Connectable.hpp.

Constructor & Destructor Documentation

torc::generic::Connectable::Connectable ( )

protected

Definition at line 151 of file Connectable.cpp.

: mConnectedNets(), mSigNetConnected(), mSigNetDisconnected() {}

torc::generic::Connectable::~Connectable ( ) throw ( )

protectedvirtual

Definition at line 153 of file Connectable.cpp.

                                   {
    mConnectedNets.clear();
}

torc::generic::Connectable::Connectable ( const Connectable &  rhs )

private

Member Function Documentation

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

pure 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.

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.

Implemented in torc::generic::VectorPortReference, torc::generic::PortBundleReference, torc::generic::VectorNet, torc::generic::PortBundle, torc::generic::NetBundle, torc::generic::VectorPort, torc::generic::ScalarPort, torc::generic::ScalarNet, torc::generic::ScalarPortReference, torc::generic::PortList, torc::generic::VectorNetBit, torc::generic::VectorPortBit, and torc::generic::VectorPortBitReference.

Definition at line 60 of file Connectable.cpp.

                                                                                  {
    Connection connection = mConnectedNets.insert(mConnectedNets.end(), inNet);
    try {
        onConnect();
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
    signalNetConnected()(inNet);
    return connection;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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

pure 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

Implemented in torc::generic::VectorPortReference, torc::generic::PortBundleReference, torc::generic::PortBundle, torc::generic::VectorNet, torc::generic::VectorPort, torc::generic::NetBundle, torc::generic::ScalarPort, torc::generic::ScalarNet, torc::generic::ScalarPortReference, torc::generic::PortList, torc::generic::VectorNetBit, torc::generic::VectorPortBit, and torc::generic::VectorPortBitReference.

Definition at line 83 of file Connectable.cpp.

                                                                                    {
    if(inConnection == mConnectedNets.end()) {
        return;
    }

    NetSharedPtr net = *inConnection;
    mConnectedNets.erase(inConnection);
    try {
        onDisconnect();
    } catch(Error& e) {
        e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
        throw;
    }
    signalNetDisconnected()(net);
    return;
}

Here is the call graph for this function:

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

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
	)

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 )

virtual

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::Connectable::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 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:

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

protectedvirtual

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

Definition at line 144 of file Connectable.cpp.

{}

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

protectedvirtual

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

Definition at line 149 of file Connectable.cpp.

{}

Connectable& torc::generic::Connectable::operator= ( const Connectable &  rhs )

private

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

inline

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 ( )

inline

A signal to indicate that a new connection has been made

Definition at line 174 of file Connectable.hpp.

                                                                   {
    return mSigNetDisconnected;
}

Field Documentation

std::list<NetSharedPtr> torc::generic::Connectable::mConnectedNets

private

Definition at line 159 of file Connectable.hpp.

Connected torc::generic::Connectable::mSigNetConnected

private

Definition at line 160 of file Connectable.hpp.

Disconnected torc::generic::Connectable::mSigNetDisconnected

private

Definition at line 161 of file Connectable.hpp.

---

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

• Connectable.hpp
• Connectable.cpp