torc::physical::Connection Class Reference

Hierarchical componenet. More...

#include <Connection.hpp>

Inheritance diagram for torc::physical::Connection:

Collaboration diagram for torc::physical::Connection:

Public Types
typedef ConnectionPinVector::const_iterator	ConnectionPinSharedPtrConstIterator
typedef ConnectionPinVector::iterator	ConnectionPinSharedPtrIterator

Public Member Functions
	Connection (const string &inName)
	Constructor. More...
ConnectionPinSharedPtrConstIterator	connectionPinsBegin (void) const
ConnectionPinSharedPtrConstIterator	connectionPinsEnd (void) const
ConnectionPinSharedPtrIterator	connectionPinsBegin (void)
ConnectionPinSharedPtrIterator	connectionPinsEnd (void)
ConnectionPinSharedPtrConstIterator	getSource (void) const
ConnectionPinSharedPtrConstIterator	getSink (void) const
size_t	getConnectionPinCount (void) const
bool	addConnectionPin (ConnectionPin &inConnectionPinPtr)
bool	removeConnectionPin (ConnectionPin &inConnectionPinPtr)
bool	operator== (const Connection &rhs) const
const string &	getName (void) const
	Returns the object name. More...
bool	operator== (const Named &rhs) const
	Equality operator. More...

Protected Types
typedef std::string	string

Protected Attributes
ConnectionPinVector	mConnectionPins
string	mName
	The name of the object. More...

Friends
class	RcFactory
	The Factory class has direct access to our internals. More...

Detailed Description

Hierarchical componenet.

Definition at line 29 of file Connection.hpp.

Member Typedef Documentation

typedef ConnectionPinVector::const_iterator torc::physical::Connection::ConnectionPinSharedPtrConstIterator

Definition at line 40 of file Connection.hpp.

typedef ConnectionPinVector::iterator torc::physical::Connection::ConnectionPinSharedPtrIterator

Definition at line 41 of file Connection.hpp.

typedef std::string torc::physical::Connection::string

protected

Definition at line 32 of file Connection.hpp.

Constructor & Destructor Documentation

torc::physical::Connection::Connection ( const string &  inName )

inline

Constructor.

Definition at line 38 of file Connection.hpp.

: Named(inName){}

Member Function Documentation

bool torc::physical::Connection::addConnectionPin ( ConnectionPin &  inConnectionPinPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 51 of file Connection.hpp.

                                                                 {
            /// \todo Acquire mutex.
            ConnectionPinSharedPtrIterator e = connectionPinsEnd();
            ConnectionPinSharedPtrIterator result = std::find(connectionPinsEnd(), e, inConnectionPinPtr);
            if(result != e) return false;
            mConnectionPins.push_back(inConnectionPinPtr);
            return true;
            /// \todo Release mutex.
        }

Here is the call graph for this function:

ConnectionPinSharedPtrConstIterator torc::physical::Connection::connectionPinsBegin ( void  ) const

inline

Definition at line 43 of file Connection.hpp.

{ return mConnectionPins.begin(); }

Here is the caller graph for this function:

ConnectionPinSharedPtrIterator torc::physical::Connection::connectionPinsBegin ( void  )

inline

Definition at line 45 of file Connection.hpp.

{ return mConnectionPins.begin(); }

ConnectionPinSharedPtrConstIterator torc::physical::Connection::connectionPinsEnd ( void  ) const

inline

Definition at line 44 of file Connection.hpp.

{ return mConnectionPins.end(); }

Here is the caller graph for this function:

ConnectionPinSharedPtrIterator torc::physical::Connection::connectionPinsEnd ( void  )

inline

Definition at line 46 of file Connection.hpp.

{ return mConnectionPins.end(); }

size_t torc::physical::Connection::getConnectionPinCount ( void  ) const

inline

Definition at line 49 of file Connection.hpp.

{ return mConnectionPins.size(); }

const string& torc::physical::Named::getName ( void  ) const

inlineinherited

Returns the object name.

Definition at line 51 of file Named.hpp.

{ return mName; }

Here is the caller graph for this function:

ConnectionPinSharedPtrConstIterator torc::physical::Connection::getSink ( void  ) const

inline

Definition at line 48 of file Connection.hpp.

{ ConnectionPinSharedPtrConstIterator cp = mConnectionPins.begin();; ++cp; return cp; }

ConnectionPinSharedPtrConstIterator torc::physical::Connection::getSource ( void  ) const

inline

Definition at line 47 of file Connection.hpp.

{ return mConnectionPins.begin(); }

bool torc::physical::Named::operator== ( const Named &  rhs ) const

inlineinherited

Equality operator.

Definition at line 54 of file Named.hpp.

{ return mName == rhs.mName; }

bool torc::physical::Connection::operator== ( const Connection &  rhs ) const

inline

Definition at line 77 of file Connection.hpp.

{ return mName == rhs.mName; }

bool torc::physical::Connection::removeConnectionPin ( ConnectionPin &  inConnectionPinPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 62 of file Connection.hpp.

                                                                    {
            /// \todo Acquire mutex.
            ConnectionPinSharedPtrIterator e = connectionPinsEnd();
            ConnectionPinSharedPtrIterator result = std::find(connectionPinsBegin(), e, inConnectionPinPtr);
            if(result == e) return false;
            mConnectionPins.erase(result);
            /// \todo Release mutex.
            return true;
        }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class RcFactory

friend

The Factory class has direct access to our internals.

Definition at line 32 of file Connection.hpp.

Field Documentation

ConnectionPinVector torc::physical::Connection::mConnectionPins

protected

Definition at line 33 of file Connection.hpp.

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

---

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

• Connection.hpp