torc::physical::Primitive Class Reference

primitive. More...

#include <Primitive.hpp>

Inheritance diagram for torc::physical::Primitive:

Collaboration diagram for torc::physical::Primitive:

Public Types
typedef ElementSharedPtrVector::const_iterator	ElementSharedPtrConstIterator
	Constant iterator for Element shared pointers. More...
typedef ElementSharedPtrVector::iterator	ElementSharedPtrIterator
	Non-constant iterator for Element shared pointers. More...
typedef PrimitivePinSharedPtrVector::const_iterator	PrimitivePinSharedPtrConstIterator
typedef PrimitivePinSharedPtrVector::iterator	PrimitivePinSharedPtrIterator

Public Member Functions
ElementSharedPtrIterator	findElement (const string &inName)
	Find a primitive element by name. More...
bool	addElement (ElementSharedPtr &inElementPtr)
	Add a element to the primitive. More...
bool	removeElement (ElementSharedPtr &inElementPtr)
	Remove a element from the primitive. More...
bool	operator== (const Primitive &rhs) const
	Equality operator. More...
size_t	getElementCount (void) const
ElementSharedPtrConstIterator	elementsBegin (void) const
	Returns the begin constant iterator for elements. More...
ElementSharedPtrConstIterator	elementsEnd (void) const
	Returns the end constant iterator for elements. More...
ElementSharedPtrIterator	elementsBegin (void)
	Returns the begin non-constant iterator for elements. More...
ElementSharedPtrIterator	elementsEnd (void)
	Returns the end non-constant iterator for elements. More...
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
	Imported type name. More...
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
	Primitive (const string &inName)
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
ElementSharedPtrVector	mElements
	Vector of element shared pointers. More...
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

primitive.

Definition at line 33 of file Primitive.hpp.

Member Typedef Documentation

typedef ElementSharedPtrVector::const_iterator torc::physical::Primitive::ElementSharedPtrConstIterator

Constant iterator for Element shared pointers.

Definition at line 53 of file Primitive.hpp.

typedef ElementSharedPtrVector::iterator torc::physical::Primitive::ElementSharedPtrIterator

Non-constant iterator for Element shared pointers.

Definition at line 55 of file Primitive.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::Primitive::string

protected

Imported type name.

Definition at line 42 of file Primitive.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::Primitive::Primitive ( const string &  inName )

inlineprotected

Definition at line 48 of file Primitive.hpp.

: Component(inName){}   

Member Function Documentation

bool torc::physical::Primitive::addElement ( ElementSharedPtr &  inElementPtr )

inline

Add a element to the primitive.

Parameters

inElementPtr

The element to add.

Returns

true if the element was added, or false if a element with the same name already exists in the primitive.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 69 of file Primitive.hpp.

                                                {
/// \todo Acquire mutex.
ElementSharedPtrVector::iterator e = mElements.end();
ElementSharedPtrVector::iterator result = findElement(inElementPtr->getName());
if(result == e) mElements.push_back(inElementPtr);
return result == e; // return true if we added the element
/// \todo Release mutex.
}

Here is the call graph for this function:

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:

ElementSharedPtrConstIterator torc::physical::Primitive::elementsBegin ( void  ) const

inline

Returns the begin constant iterator for elements.

Definition at line 161 of file Primitive.hpp.

{ return mElements.begin(); }

Here is the caller graph for this function:

ElementSharedPtrIterator torc::physical::Primitive::elementsBegin ( void  )

inline

Returns the begin non-constant iterator for elements.

Definition at line 165 of file Primitive.hpp.

{ return mElements.begin(); }

ElementSharedPtrConstIterator torc::physical::Primitive::elementsEnd ( void  ) const

inline

Returns the end constant iterator for elements.

Definition at line 163 of file Primitive.hpp.

{ return mElements.end(); }

Here is the caller graph for this function:

ElementSharedPtrIterator torc::physical::Primitive::elementsEnd ( void  )

inline

Returns the end non-constant iterator for elements.

Definition at line 167 of file Primitive.hpp.

{ return mElements.end(); }

ElementSharedPtrIterator torc::physical::Primitive::findElement ( const string &  inName )

inline

Find a primitive element by name.

Parameters

inName

The element name to look for.

Returns

an iterator for the specified element, or elementsEnd() if the name was not found.

Definition at line 61 of file Primitive.hpp.

                                                           {
NameComparator predicate(inName);
return std::find_if(elementsBegin(), elementsEnd(), predicate);
}

Here is the call graph for this function:

Here is the caller graph for this function:

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::Primitive::getElementCount ( void  ) const

inline

Definition at line 158 of file Primitive.hpp.

{ return mElements.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; }

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

inline

Equality operator.

This function deems elements equal if their names are identical.

Parameters

rhs	The element to compare against.

Returns

true if both element names are identical, or false otherwise.

Definition at line 153 of file Primitive.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::Primitive::removeElement ( ElementSharedPtr &  inElementPtr )

inline

Remove a element from the primitive.

Parameters

inElementPtr

The element to remove.

Returns

true if the element was removed, or false if the element did not exist.

Todo:

Acquire mutex.

Definition at line 80 of file Primitive.hpp.

                                                   {
/// \todo Acquire mutex.
ElementSharedPtrVector::iterator e = mElements.end();
ElementSharedPtrVector::iterator result = std::find(mElements.begin(), e, inElementPtr);
if(result == e) return false;

//adjust connections

            ConnectionPinVector sinkPins;
            ConnectionPinVector sourcePins;
            ConnectionSharedPtrVector sourceConnections;
            ConnectionSharedPtrVector sinkConnections;
            ElementSharedPtrVector sourceElements;
            ElementSharedPtrVector sinkElements;
            
            Connection::ConnectionPinSharedPtrIterator pinIt, pinIt2;
            Element::ConnectionSharedPtrIterator cnIt, cnIt2; 
            
            ConnectionPin pin;
            
            ConnectionSharedPtr cnPtr;
            ElementSharedPtr elemPtr;
            for( cnIt = inElementPtr->connectionsBegin(); cnIt != inElementPtr->connectionsEnd(); ++cnIt){
                if( (*cnIt)->getSource()->getElementName() == inElementPtr->getName() ){
                    pin = *(*cnIt)->getSink();
                    sinkPins.push_back(pin);
                    elemPtr = *findElement(pin.getElementName());
                    sinkElements.push_back(elemPtr);
                    for(cnIt2 = elemPtr->connectionsBegin(); cnIt2 != elemPtr->connectionsEnd(); ++cnIt2){
                        if( (*cnIt2)->getSink()->getPinName() == pin.getPinName()){
                            sinkConnections.push_back(*cnIt2);
                            elemPtr->removeConnection(cnIt2);
                            break;
                        }
                    }   
                }
                else{
                    pin = *(*cnIt)->getSource();
                    sourcePins.push_back(pin);
                    elemPtr = *findElement(pin.getElementName());
                    sourceElements.push_back(elemPtr);
                    for(cnIt2 = elemPtr->connectionsBegin(); cnIt2 != elemPtr->connectionsEnd(); ++cnIt2){
                        if( (*cnIt2)->getSource()->getPinName() == pin.getPinName()){
                            sourceConnections.push_back(*cnIt2);
                            elemPtr->removeConnection(cnIt2);
                            break;
                        }
                    }   
                }
            }
            for(size_t i=0; i<sourcePins.size(); ++i){
                for(size_t j=0; j<sinkPins.size(); ++j){
                    ConnectionSharedPtr connectionPtr(new Connection(sourcePins[i].getPinName()));
                    ConnectionSharedPtr connectionPtr1(new Connection(sourcePins[i].getPinName()));
                    connectionPtr->addConnectionPin(sourcePins[i]);
                    connectionPtr->addConnectionPin(sinkPins[j]);
                    sinkElements[j]->addConnection(connectionPtr);
                    
                    connectionPtr1->addConnectionPin(sourcePins[i]);
                    connectionPtr1->addConnectionPin(sinkPins[j]);
                    sourceElements[i]->addConnection(connectionPtr1);
        
                }
            }
            mElements.erase(result);
return true;
}

Here is the call graph for this function:

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 37 of file Primitive.hpp.

Field Documentation

ElementSharedPtrVector torc::physical::Primitive::mElements

protected

Vector of element shared pointers.

Definition at line 45 of file Primitive.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:

• Primitive.hpp