torc::physical::Element Class Reference

Element composed of connections and pins. More...

#include <Element.hpp>

Inheritance diagram for torc::physical::Element:

Collaboration diagram for torc::physical::Element:

Public Types
typedef ConnectionSharedPtrVector::const_iterator	ConnectionSharedPtrConstIterator
typedef ConnectionSharedPtrVector::iterator	ConnectionSharedPtrIterator
typedef ConfigVector::const_iterator	ConfigConstIterator
typedef ConfigVector::iterator	ConfigIterator
typedef PrimitivePinSharedPtrVector::const_iterator	PrimitivePinSharedPtrConstIterator
typedef PrimitivePinSharedPtrVector::iterator	PrimitivePinSharedPtrIterator

Public Member Functions
bool	addConnection (ConnectionSharedPtr &inConnectionPtr)
bool	removeConnection (ConnectionSharedPtr &inConnectionPtr)
bool	removeConnection (ConnectionSharedPtrIterator inConnectionIter)
ConnectionSharedPtrConstIterator	connectionsBegin (void) const
ConnectionSharedPtrConstIterator	connectionsEnd (void) const
ConnectionSharedPtrIterator	connectionsBegin (void)
ConnectionSharedPtrIterator	connectionsEnd (void)
size_t	getConnectionCount (void) const
bool	addConfig (string &inConfigPtr)
bool	removeConfig (string &inConfigPtr)
ConfigConstIterator	confsBegin (void) const
ConfigConstIterator	confsEnd (void) const
ConfigIterator	confsBegin (void)
ConfigIterator	confsEnd (void)
size_t	getConfigCount (void) const
size_t	getPrimitivePinCount (void) const
PrimitivePinSharedPtrConstIterator	PrimitivePinsBegin (void) const
PrimitivePinSharedPtrIterator	PrimitivePinsBegin (void)
PrimitivePinSharedPtrConstIterator	PrimitivePinsEnd (void) const
PrimitivePinSharedPtrIterator	PrimitivePinsEnd (void)
bool	addPrimitivePin (PrimitivePinSharedPtr &inPrimitivePinPtr)
bool	removePrimitivePin (PrimitivePinSharedPtr &inPrimitivePinPtr)
PrimitivePinSharedPtrIterator	findPrimitivePin (const string &inName)
bool	operator== (const Component &rhs) const
bool	operator== (const Named &rhs) const
	Equality operator. More...
const string &	getName (void) const
	Returns the object name. More...
const WeakPtrType &	getParentWeakPtr (void) const
	Returns a weak pointer to the parent. More...
void	setParentWeakPtr (WeakPtrType inParentPtr)
	Sets the weak pointer to the parent. More...
void	resetParentWeakPtr (void)
	Method to reset and orphan this object. More...
const SharedPtrType &	getParentSharedPtr (void) const
	Returns a shared pointer to the parent (WARNING: Does not work right). More...

Protected Types
typedef std::string	string
typedef boost::weak_ptr< class Component >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::weak_ptr< class Component >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::shared_ptr < class Component >	SharedPtrType
	Shared pointer of our own type. More...
typedef boost::shared_ptr < class Component >	SharedPtrType
	Shared pointer of our own type. More...

Protected Member Functions
	Element (const string &inName)
	Constructor. More...
void	setSelfWeakPtr (WeakPtrType inSelfPtr)
	Sets the weak pointer to this object. More...
const WeakPtrType &	getSelfWeakPtr (void) const
	Returns a weak pointer to this object. More...

Protected Attributes
ConnectionSharedPtrVector	mConnections
ConfigVector	mConfigs
PrimitivePinSharedPtrVector	mPrimitivePins
string	mName
	The name of the object. More...
WeakPtrType	mParentWeakPtr
	Weak pointer to the parent. More...
WeakPtrType	mSelfWeakPtr
	Weak pointer this object. More...

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

Detailed Description

Element composed of connections and pins.

This class implements everything for XDLRC elements.

Definition at line 41 of file Element.hpp.

Member Typedef Documentation

typedef ConfigVector::const_iterator torc::physical::Element::ConfigConstIterator

Definition at line 57 of file Element.hpp.

typedef ConfigVector::iterator torc::physical::Element::ConfigIterator

Definition at line 58 of file Element.hpp.

typedef ConnectionSharedPtrVector::const_iterator torc::physical::Element::ConnectionSharedPtrConstIterator

Definition at line 54 of file Element.hpp.

typedef ConnectionSharedPtrVector::iterator torc::physical::Element::ConnectionSharedPtrIterator

Definition at line 55 of file Element.hpp.

typedef PrimitivePinSharedPtrVector::const_iterator torc::physical::Component::PrimitivePinSharedPtrConstIterator

inherited

Definition at line 39 of file Component.hpp.

typedef PrimitivePinSharedPtrVector::iterator torc::physical::Component::PrimitivePinSharedPtrIterator

inherited

Definition at line 40 of file Component.hpp.

typedef boost::shared_ptr<class Component > torc::physical::Progeny< class Component >::SharedPtrType

protectedinherited

Shared pointer of our own type.

Definition at line 35 of file Progeny.hpp.

typedef boost::shared_ptr<class Component > torc::physical::Progenitor< class Component >::SharedPtrType

protectedinherited

Shared pointer of our own type.

Definition at line 52 of file Progenitor.hpp.

typedef std::string torc::physical::Component::string

protectedinherited

Definition at line 33 of file Component.hpp.

typedef boost::weak_ptr<class Component > torc::physical::Progeny< class Component >::WeakPtrType

protectedinherited

Weak pointer of our own type.

Definition at line 33 of file Progeny.hpp.

typedef boost::weak_ptr<class Component > torc::physical::Progenitor< class Component >::WeakPtrType

protectedinherited

Weak pointer of our own type.

Definition at line 50 of file Progenitor.hpp.

Constructor & Destructor Documentation

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

inlineprotected

Constructor.

Definition at line 51 of file Element.hpp.

: Component(inName){}       

Member Function Documentation

bool torc::physical::Element::addConfig ( string &  inConfigPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 92 of file Element.hpp.

                                            {
            /// \todo Acquire mutex.
            ConfigIterator e = mConfigs.end();
            ConfigIterator result = std::find(mConfigs.begin(), e, inConfigPtr);
            if(result != e) return false;
            mConfigs.push_back(inConfigPtr);
            return true;
            /// \todo Release mutex.
        }

bool torc::physical::Element::addConnection ( ConnectionSharedPtr &  inConnectionPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 61 of file Element.hpp.

                                                                 {
            /// \todo Acquire mutex.
            mConnections.push_back(inConnectionPtr);
            return true;
            /// \todo Release mutex.
        }

bool torc::physical::Component::addPrimitivePin ( PrimitivePinSharedPtr &  inPrimitivePinPtr )

inlineinherited

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 48 of file Component.hpp.

                                                                       {
            /// \todo Acquire mutex.
            PrimitivePinSharedPtrIterator e = PrimitivePinsEnd();
            PrimitivePinSharedPtrIterator result = std::find(PrimitivePinsEnd(), e, inPrimitivePinPtr);
            if(result != e) return false;
            mPrimitivePins.push_back(inPrimitivePinPtr);
            return true;
            /// \todo Release mutex.
        }

Here is the call graph for this function:

ConfigConstIterator torc::physical::Element::confsBegin ( void  ) const

inline

Definition at line 111 of file Element.hpp.

{ return mConfigs.begin(); }

ConfigIterator torc::physical::Element::confsBegin ( void  )

inline

Definition at line 113 of file Element.hpp.

{ return mConfigs.begin(); }

ConfigConstIterator torc::physical::Element::confsEnd ( void  ) const

inline

Definition at line 112 of file Element.hpp.

{ return mConfigs.end(); }

ConfigIterator torc::physical::Element::confsEnd ( void  )

inline

Definition at line 114 of file Element.hpp.

{ return mConfigs.end(); }

ConnectionSharedPtrConstIterator torc::physical::Element::connectionsBegin ( void  ) const

inline

Definition at line 86 of file Element.hpp.

{ return mConnections.begin(); }

ConnectionSharedPtrIterator torc::physical::Element::connectionsBegin ( void  )

inline

Definition at line 88 of file Element.hpp.

{ return mConnections.begin(); }

ConnectionSharedPtrConstIterator torc::physical::Element::connectionsEnd ( void  ) const

inline

Definition at line 87 of file Element.hpp.

{ return mConnections.end(); }

ConnectionSharedPtrIterator torc::physical::Element::connectionsEnd ( void  )

inline

Definition at line 89 of file Element.hpp.

{ return mConnections.end(); }

PrimitivePinSharedPtrIterator torc::physical::Component::findPrimitivePin ( const string &  inName )

inlineinherited

Definition at line 66 of file Component.hpp.

                                                                             {
            NameComparator predicate(inName);
            return std::find_if(PrimitivePinsBegin(), PrimitivePinsEnd(), predicate);
        }

Here is the call graph for this function:

size_t torc::physical::Element::getConfigCount ( void  ) const

inline

Definition at line 115 of file Element.hpp.

{ return mConfigs.size(); }

size_t torc::physical::Element::getConnectionCount ( void  ) const

inline

Definition at line 90 of file Element.hpp.

{ return mConnections.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:

const SharedPtrType& torc::physical::Progeny< class Component >::getParentSharedPtr ( void  ) const

inlineinherited

Returns a shared pointer to the parent (WARNING: Does not work right).

Always seems to generate a "Returning reference to temporary" warning, and I cannot figure out why.

It is the caller's responsibility to reset the shared pointer when done.

Todo:

Figure out why Progeny<T>::getParentSharedPtr() yields a "Returning reference to temporary" warning.

Definition at line 59 of file Progeny.hpp.

{ return mParentWeakPtr.lock(); }

const WeakPtrType& torc::physical::Progeny< class Component >::getParentWeakPtr ( void  ) const

inlineinherited

Returns a weak pointer to the parent.

Definition at line 47 of file Progeny.hpp.

{ return mParentWeakPtr; }

size_t torc::physical::Component::getPrimitivePinCount ( void  ) const

inlineinherited

Definition at line 42 of file Component.hpp.

{ return mPrimitivePins.size(); }

const WeakPtrType& torc::physical::Progenitor< class Component >::getSelfWeakPtr ( void  ) const

inlineinherited

Returns a weak pointer to this object.

Definition at line 68 of file Progenitor.hpp.

{ return mSelfWeakPtr; }

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::Component::operator== ( const Component &  rhs ) const

inlineinherited

Definition at line 71 of file Component.hpp.

{ return mName == rhs.mName; }

PrimitivePinSharedPtrConstIterator torc::physical::Component::PrimitivePinsBegin ( void  ) const

inlineinherited

Definition at line 43 of file Component.hpp.

{ return mPrimitivePins.begin(); }

Here is the caller graph for this function:

PrimitivePinSharedPtrIterator torc::physical::Component::PrimitivePinsBegin ( void  )

inlineinherited

Definition at line 45 of file Component.hpp.

{ return mPrimitivePins.begin(); }

PrimitivePinSharedPtrConstIterator torc::physical::Component::PrimitivePinsEnd ( void  ) const

inlineinherited

Definition at line 44 of file Component.hpp.

{ return mPrimitivePins.end(); }

Here is the caller graph for this function:

PrimitivePinSharedPtrIterator torc::physical::Component::PrimitivePinsEnd ( void  )

inlineinherited

Definition at line 46 of file Component.hpp.

{ return mPrimitivePins.end(); }

bool torc::physical::Element::removeConfig ( string &  inConfigPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 101 of file Element.hpp.

                                               {
            /// \todo Acquire mutex.
            ConfigIterator e = mConfigs.end();
            ConfigIterator result = std::find(mConfigs.begin(), e, inConfigPtr);
            if(result == e) return false;
            mConfigs.erase(result);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Element::removeConnection ( ConnectionSharedPtr &  inConnectionPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 67 of file Element.hpp.

                                                                    {
            /// \todo Acquire mutex.
            ConnectionSharedPtrIterator e = connectionsEnd();
            ConnectionSharedPtrIterator result = std::find(connectionsBegin(), e, inConnectionPtr);
            if(result == e) return false;
            mConnections.erase(result);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Element::removeConnection ( ConnectionSharedPtrIterator  inConnectionIter )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 77 of file Element.hpp.

                                                                            {
            /// \todo Acquire mutex.
            
            mConnections.erase(inConnectionIter);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Component::removePrimitivePin ( PrimitivePinSharedPtr &  inPrimitivePinPtr )

inlineinherited

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 57 of file Component.hpp.

                                                                          {
            /// \todo Acquire mutex.
            PrimitivePinSharedPtrIterator e = PrimitivePinsEnd();
            PrimitivePinSharedPtrIterator result = std::find(PrimitivePinsBegin(), e, inPrimitivePinPtr);
            if(result == e) return false;
            mPrimitivePins.erase(result);
            /// \todo Release mutex.
            return true;
        }

Here is the call graph for this function:

void torc::physical::Progeny< class Component >::resetParentWeakPtr ( void  )

inlineinherited

Method to reset and orphan this object.

Definition at line 51 of file Progeny.hpp.

{ mParentWeakPtr.reset(); }

void torc::physical::Progeny< class Component >::setParentWeakPtr ( WeakPtrType  inParentPtr )

inlineinherited

Sets the weak pointer to the parent.

Definition at line 49 of file Progeny.hpp.

{ mParentWeakPtr = inParentPtr; }

void torc::physical::Progenitor< class Component >::setSelfWeakPtr ( WeakPtrType  inSelfPtr )

inlineprotectedinherited

Sets the weak pointer to this object.

Definition at line 59 of file Progenitor.hpp.

{ mSelfWeakPtr = inSelfPtr; }

Friends And Related Function Documentation

friend class RcFactory

friend

The Factory class has direct access to our internals.

Definition at line 44 of file Element.hpp.

Field Documentation

ConfigVector torc::physical::Element::mConfigs

protected

Definition at line 48 of file Element.hpp.

ConnectionSharedPtrVector torc::physical::Element::mConnections

protected

Definition at line 47 of file Element.hpp.

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

WeakPtrType torc::physical::Progeny< class Component >::mParentWeakPtr

protectedinherited

Weak pointer to the parent.

Definition at line 38 of file Progeny.hpp.

PrimitivePinSharedPtrVector torc::physical::Component::mPrimitivePins

protectedinherited

Definition at line 34 of file Component.hpp.

WeakPtrType torc::physical::Progenitor< class Component >::mSelfWeakPtr

protectedinherited

Weak pointer this object.

This weak pointer is kept here to be passed along to our children, allowing them to point back to us without the strong dependency of a shared pointer.

Definition at line 57 of file Progenitor.hpp.

---

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

• Element.hpp