torc::physical::Module Class Reference

Hierarchical module. More...

#include <Module.hpp>

Inheritance diagram for torc::physical::Module:

Collaboration diagram for torc::physical::Module:

Public Types
typedef PortSharedPtrVector::const_iterator	PortSharedPtrConstIterator
	Constant iterator to Port shared pointers. More...
typedef PortSharedPtrVector::iterator	PortSharedPtrIterator
	Non-constant iterator to Port shared pointers. More...
typedef InstanceSharedPtrVector::const_iterator	InstanceSharedPtrConstIterator
	Constant iterator to Instance shared pointers. More...
typedef InstanceSharedPtrVector::iterator	InstanceSharedPtrIterator
	Non-constant iterator to Instance shared pointers. More...
typedef NetSharedPtrVector::const_iterator	NetSharedPtrConstIterator
	Constant iterator to Net shared pointers. More...
typedef NetSharedPtrVector::iterator	NetSharedPtrIterator
	Non-constant iterator to Net shared pointers. More...
typedef const_iterator	const_iterator
	Constant iterator to {setting,Config} pairs. More...
enum	EAnnotationType {   ePlacerInstanceTypeIndex, ePlacerInstanceSitePtr, ePlacerInstanceDependentInstanceAbove, ePlacerInstanceDependsOnInstanceBelow,   eRouterNetTilewireSources, eRouterNetTilewireSinks, eRouterNetArcList, eRouterNetRouteNodePtrVector,   eRouterNetRouteTime, eRouterNetArcVector, eAnnotationGlobalRouter, eAnnotationCount }
	Enumeration for all types of annotations. More...

Public Member Functions
PortSharedPtrIterator	findPort (const string &inName)
	Find a port by name. More...
bool	addPort (PortSharedPtr &inPortPtr)
	Add a port to the module. More...
bool	removePort (PortSharedPtr &inPortPtr)
const string &	getAnchor (void) const
	Returns the anchor instance name for this module. More...
void	setAnchor (const string &inAnchor)
	Sets the anchor instance name for this module. More...
PortSharedPtrConstIterator	portsBegin (void) const
	Returns the begin constant iterator for ports. More...
PortSharedPtrConstIterator	portsEnd (void) const
	Returns the end constant iterator for ports. More...
PortSharedPtrIterator	portsBegin (void)
	Returns the begin non-constant iterator for ports. More...
PortSharedPtrIterator	portsEnd (void)
	Returns the end non-constant iterator for ports. More...
size_t	getPortCount (void) const
	Returns the number of ports in the module. More...
bool	operator== (const Module &rhs) const
	Equality operator. More...
InstanceSharedPtrIterator	findInstance (const string &inName)
	Find a circuit instance by name. More...
bool	addInstance (InstanceSharedPtr &inInstancePtr)
	Add an instance to the circuit. More...
bool	removeInstance (InstanceSharedPtr &inInstancePtr)
	Remove an instance from the circuit. More...
void	unplace (void)
	Unplace the circuit by discarding placement information for each instance. More...
NetSharedPtrIterator	findNet (const string &inName)
	Find a circuit net by name. More...
bool	addNet (NetSharedPtr &inNetPtr)
	Add a net to the circuit. More...
bool	removeNet (NetSharedPtr &inNetPtr)
	Remove a net from the circuit. More...
void	unroute (void)
	Unroute the circuit by discarding routing information for each net. More...
InstanceSharedPtrConstIterator	instancesBegin (void) const
	Returns the begin constant iterator for instances. More...
InstanceSharedPtrIterator	instancesBegin (void)
	Returns the begin non-constant iterator for instances. More...
InstanceSharedPtrConstIterator	instancesEnd (void) const
	Returns the end constant iterator for instances. More...
InstanceSharedPtrIterator	instancesEnd (void)
	Returns the end non-constant iterator for instances. More...
size_t	getInstanceCount (void) const
	Returns the number of instances in the circuit. More...
NetSharedPtrConstIterator	netsBegin (void) const
	Returns the begin constant iterator for nets. More...
NetSharedPtrIterator	netsBegin (void)
	Returns the begin non-constant iterator for nets. More...
NetSharedPtrConstIterator	netsEnd (void) const
	Returns the end constant iterator for nets. More...
NetSharedPtrIterator	netsEnd (void)
	Returns the end non-constant iterator for nets. More...
size_t	getNetCount (void) const
	Returns the number of nets in the circuit. More...
const string &	getName (void) const
	Returns the object name. More...
bool	operator== (const Named &rhs) const
	Equality operator. 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...
const_iterator	configBegin (void) const
	Returns the begin constant iterator for configurations. More...
const_iterator	configEnd (void) const
	Returns the end constant iterator for configurations. More...
size_t	getConfigCount (void) const
	Returns the number of configurations in the map. More...
bool	configIsEmpty (void) const
	Returns true if the configuration map is empty. More...
void	clearConfig (void)
	Clears the configuration map. More...
bool	hasConfig (const string &inSetting) const
	Returns true if the specified setting exists in the map. More...
bool	getConfig (const string &inSetting, Config &outConfig)
	Looks up the specified setting in the map. More...
bool	getConfig (const string &inSetting, string &outName, string &outValue)
	Looks up the specified setting in the map. More...
void	setConfig (const string &inSetting, const Config &inConfig)
	Sets the configuration for the given setting. More...
void	setConfig (const string &inSetting, const string &inName, const string &inValue)
	Sets the configuration for the given setting. More...
bool	removeConfig (const string &inSetting)
	Removes the named configuration. More...
void	addConfigs (const ConfigMap &inConfigMap)
	Merges the configurations from the given ConfigMap into this one. More...
std::pair< iterator, iterator >	getMultiConfigValues (const string &inSetting)
	Returns a range that encompasses all of the configurations for the given setting. More...
size_type	getMultiConfigCount (const string &inSetting)
	Returns the number of configurations for the given setting. More...
boost::any	getAnnotation (uint32 inKey)
	Get an annotation. Returns an empty annotation if the index doesn't exist. More...
void	setAnnotation (uint32 inKey, boost::any inValue)
	Set an annotation. More...
void	removeAnnotation (uint32 inKey)
	Remove an annotation. More...
bool	hasAnnotation (uint32 inKey)
	Check if an annotation exists. More...

Static Public Member Functions
static bool	allowConfigDuplicates (const string &inSetting)
	Returns true if multiple configurations are allowed for the given setting. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef boost::int64_t	int64_t
	Imported type name. More...
typedef std::map< std::string, int64_t >	NameToIndexMap
	Map from an element name to a vector index. More...
typedef boost::weak_ptr< class Circuit >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::weak_ptr< class Circuit >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::shared_ptr < class Circuit >	SharedPtrType
	Shared pointer of our own type. More...
typedef boost::shared_ptr < class Circuit >	SharedPtrType
	Shared pointer of our own type. More...
typedef std::multimap < std::string, Config >	super
	Convenience typedef to represent our superclass. More...
typedef boost::weak_ptr< Module >	WeakPtrType
	Weak pointer of our own type. More...
typedef boost::shared_ptr< Module >	SharedPtrType
	Shared pointer of our own type. More...

Protected Member Functions
	Module (const string &inName, const string &inAnchor)
	Protected 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...
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
string	mAnchor
	The module anchor instance name. More...
PortSharedPtrVector	mPorts
	Vector of Port shared pointers for the module. More...
InstanceSharedPtrVector	mInstances
	Vector of Instance shared pointers for the circuit. More...
NameToIndexMap	mInstanceMap
	Instance name to index mapping for this circuit. More...
NetSharedPtrVector	mNets
	Vector of Net shared pointers for the circuit. More...
NameToIndexMap	mNetMap
	Net name to index mapping for this circuit. More...
string	mName
	The name of the object. More...
WeakPtrType	mParentWeakPtr
	Weak pointer to the parent. More...
SequenceIndex	mNextSequenceIndex
	Sequence index to use for the next configuration added to this map. More...
boost::unordered_map < boost::uint32_t, boost::any >	mAnnotations
	Map containing any annotations. More...
WeakPtrType	mSelfWeakPtr
	Weak pointer this object. More...
WeakPtrType	mSelfWeakPtr
	Weak pointer this object. More...

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

Detailed Description

Hierarchical module.

Modules are used for hard macros in the Xilinx tool flow. For most users, modules never appear in XDL netlists, either because the design did not use hard macros, or because those hard macros were flattened as instances and nets directly in the design.

Definition at line 33 of file Module.hpp.

Member Typedef Documentation

typedef const_iterator torc::physical::ConfigMap::const_iterator

inherited

Constant iterator to {setting,Config} pairs.

Definition at line 52 of file ConfigMap.hpp.

typedef InstanceSharedPtrVector::const_iterator torc::physical::Circuit::InstanceSharedPtrConstIterator

inherited

Constant iterator to Instance shared pointers.

Definition at line 72 of file Circuit.hpp.

typedef InstanceSharedPtrVector::iterator torc::physical::Circuit::InstanceSharedPtrIterator

inherited

Non-constant iterator to Instance shared pointers.

Definition at line 74 of file Circuit.hpp.

typedef boost::int64_t torc::physical::Circuit::int64_t

protectedinherited

Imported type name.

Definition at line 53 of file Circuit.hpp.

typedef std::map<std::string, int64_t> torc::physical::Circuit::NameToIndexMap

protectedinherited

Map from an element name to a vector index.

Definition at line 55 of file Circuit.hpp.

typedef NetSharedPtrVector::const_iterator torc::physical::Circuit::NetSharedPtrConstIterator

inherited

Constant iterator to Net shared pointers.

Definition at line 76 of file Circuit.hpp.

typedef NetSharedPtrVector::iterator torc::physical::Circuit::NetSharedPtrIterator

inherited

Non-constant iterator to Net shared pointers.

Definition at line 78 of file Circuit.hpp.

typedef PortSharedPtrVector::const_iterator torc::physical::Module::PortSharedPtrConstIterator

Constant iterator to Port shared pointers.

Definition at line 55 of file Module.hpp.

typedef PortSharedPtrVector::iterator torc::physical::Module::PortSharedPtrIterator

Non-constant iterator to Port shared pointers.

Definition at line 57 of file Module.hpp.

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

protectedinherited

Shared pointer of our own type.

Definition at line 35 of file Progeny.hpp.

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

protectedinherited

Shared pointer of our own type.

Definition at line 52 of file Progenitor.hpp.

typedef boost::shared_ptr<Module > torc::physical::Progenitor< Module >::SharedPtrType

protectedinherited

Shared pointer of our own type.

Definition at line 52 of file Progenitor.hpp.

typedef std::string torc::physical::Module::string

protected

Imported type name.

Definition at line 40 of file Module.hpp.

typedef std::multimap<std::string, Config> torc::physical::ConfigMap::super

protectedinherited

Convenience typedef to represent our superclass.

Definition at line 45 of file ConfigMap.hpp.

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

protectedinherited

Weak pointer of our own type.

Definition at line 33 of file Progeny.hpp.

typedef boost::weak_ptr<Module > torc::physical::Progenitor< Module >::WeakPtrType

protectedinherited

Weak pointer of our own type.

Definition at line 50 of file Progenitor.hpp.

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

protectedinherited

Weak pointer of our own type.

Definition at line 50 of file Progenitor.hpp.

Member Enumeration Documentation

enum torc::common::Annotated::EAnnotationType

inherited

Enumeration for all types of annotations.

Enumerator
ePlacerInstanceTypeIndex
ePlacerInstanceSitePtr
ePlacerInstanceDependentInstanceAbove
ePlacerInstanceDependsOnInstanceBelow
eRouterNetTilewireSources
eRouterNetTilewireSinks
eRouterNetArcList
eRouterNetRouteNodePtrVector
eRouterNetRouteTime
eRouterNetArcVector
eAnnotationGlobalRouter
eAnnotationCount

Definition at line 57 of file Annotated.hpp.

                             {
            ePlacerInstanceTypeIndex,
            ePlacerInstanceSitePtr,
            ePlacerInstanceDependentInstanceAbove,
            ePlacerInstanceDependsOnInstanceBelow,
            eRouterNetTilewireSources,
            eRouterNetTilewireSinks,
            eRouterNetArcList,
            eRouterNetRouteNodePtrVector,
            eRouterNetRouteTime,
            eRouterNetArcVector,
            eAnnotationGlobalRouter,
            eAnnotationCount
        };

Constructor & Destructor Documentation

torc::physical::Module::Module ( const string &  inName, const string &  inAnchor  )

inlineprotected

Protected constructor.

Parameters

inName	The module name.
inAnchor	The anchor instance name for the module. The anchor designates the instance in the module relative to which the module will be placed.

Definition at line 51 of file Module.hpp.

: Circuit(inName), mAnchor(inAnchor) {}

Member Function Documentation

void torc::physical::ConfigMap::addConfigs ( const ConfigMap &  inConfigMap )

inlineinherited

Merges the configurations from the given ConfigMap into this one.

For each setting, if the setting does not already exist in the map, it is added. If the setting does exist, then the incoming configuration either replaces the existing setting (in the case of regular settings), or is added to the map (in the case of special settings for which multiple configurations are allowed).

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 159 of file ConfigMap.hpp.

                                                      {
            if(inConfigMap.empty()) return;
            /// \todo Acquire mutex.
            const_iterator p = inConfigMap.begin();
            const_iterator e = inConfigMap.end();
            while(p != e) {
                // look up the config information
                const string& setting = p->first;
                const Config& config = p->second;
                // try to insert the setting into the map (while respecting our special semantics)
                setConfig(setting, config);
                p++;
            }
            /// \todo Release mutex.
        }

Here is the call graph for this function:

Here is the caller graph for this function:

bool torc::physical::Circuit::addInstance ( InstanceSharedPtr &  inInstancePtr )

inlineinherited

Add an instance to the circuit.

Parameters

inInstancePtr

The instance to add.

Returns

true if the instance was added, or false if an instance with the same name already exists in the circuit.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 94 of file Circuit.hpp.

                                                           {
            /// \todo Acquire mutex.
            const std::string& name = inInstancePtr->getName();
            InstanceSharedPtrIterator e = mInstances.end();
            InstanceSharedPtrIterator result = findInstance(name);
            if(result != e) return false;
            inInstancePtr->setParentWeakPtr(mParentWeakPtr);
            mInstanceMap[name] = mInstances.size();
            mInstances.push_back(inInstancePtr);
            return true;
            /// \todo Release mutex.
        }

Here is the call graph for this function:

bool torc::physical::Circuit::addNet ( NetSharedPtr &  inNetPtr )

inlineinherited

Add a net to the circuit.

Parameters

inNetPtr

The net to add.

Returns

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

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 151 of file Circuit.hpp.

                                            {
            /// \todo Acquire mutex.
            const std::string& name = inNetPtr->getName();
            NetSharedPtrIterator e = mNets.end();
            NetSharedPtrIterator result = findNet(name);
            if(result != e) return false;
            inNetPtr->setParentWeakPtr(mParentWeakPtr);
            mNetMap[name] = mNets.size();
            mNets.push_back(inNetPtr);
            return true;
            /// \todo Release mutex.
        }

Here is the call graph for this function:

bool torc::physical::Module::addPort ( PortSharedPtr &  inPortPtr )

inline

Add a port to the module.

Parameters

inPortPtr

The port to add.

Returns

true if the instance was added, or false if an instance with the same name already exists in the circuit.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 70 of file Module.hpp.

                                               {
            /// \todo Acquire mutex.
            PortSharedPtrIterator e = portsEnd();
            PortSharedPtrIterator result = findPort(inPortPtr->getName());
            if(result != e) return false;
            mPorts.push_back(inPortPtr);
            inPortPtr->Progeny<Module>::setParentWeakPtr(Progenitor<Module>::mSelfWeakPtr);
            return true;
            /// \todo Release mutex.
        }

Here is the call graph for this function:

static bool torc::physical::ConfigMap::allowConfigDuplicates ( const string &  inSetting )

inlinestaticinherited

Returns true if multiple configurations are allowed for the given setting.

Special Xilinx settings prefixed with an underscore may have multiple configurations in the map.

Definition at line 177 of file ConfigMap.hpp.

                                                                   {
            return inSetting.size() >= 1 && inSetting[0] == '_';
        }

Here is the caller graph for this function:

void torc::physical::ConfigMap::clearConfig ( void  )

inlineinherited

Clears the configuration map.

Definition at line 67 of file ConfigMap.hpp.

{ ConfigMap::clear(); }

Here is the caller graph for this function:

const_iterator torc::physical::ConfigMap::configBegin ( void  ) const

inlineinherited

Returns the begin constant iterator for configurations.

Definition at line 58 of file ConfigMap.hpp.

{ return super::begin(); }

Here is the caller graph for this function:

const_iterator torc::physical::ConfigMap::configEnd ( void  ) const

inlineinherited

Returns the end constant iterator for configurations.

Definition at line 60 of file ConfigMap.hpp.

{ return super::end(); }

Here is the caller graph for this function:

bool torc::physical::ConfigMap::configIsEmpty ( void  ) const

inlineinherited

Returns true if the configuration map is empty.

Definition at line 65 of file ConfigMap.hpp.

{ return super::empty(); }

Here is the caller graph for this function:

InstanceSharedPtrIterator torc::physical::Circuit::findInstance ( const string &  inName )

inlineinherited

Find a circuit instance by name.

Parameters

inName

The instance name to look for.

Returns

an iterator for the specified instance, or instancesEnd() if the name was not found.

Definition at line 84 of file Circuit.hpp.

                                                                     {
            NameToIndexMap::iterator result = mInstanceMap.find(inName);
            NameToIndexMap::iterator e = mInstanceMap.end();
            if(result == e) return instancesEnd();
            return instancesBegin() + result->second;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

NetSharedPtrIterator torc::physical::Circuit::findNet ( const string &  inName )

inlineinherited

Find a circuit net by name.

Parameters

inName

The net name to look for.

Returns

an iterator to the specified net, or netsEnd() if the name was not found.

Definition at line 141 of file Circuit.hpp.

                                                           {
            NameToIndexMap::iterator result = mNetMap.find(inName);
            NameToIndexMap::iterator e = mNetMap.end();
            if(result == e) return netsEnd();
            return netsBegin() + result->second;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

PortSharedPtrIterator torc::physical::Module::findPort ( const string &  inName )

inline

Find a port by name.

Parameters

inName

The port name to look for.

Returns

an iterator for the specified port, or portsEnd() if the name was not found.

Definition at line 62 of file Module.hpp.

                                                             {
            NameComparator predicate(inName);
            return std::find_if(portsBegin(), portsEnd(), predicate);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

const string& torc::physical::Module::getAnchor ( void  ) const

inline

Returns the anchor instance name for this module.

Definition at line 91 of file Module.hpp.

{ return mAnchor; }

Here is the caller graph for this function:

boost::any torc::common::Annotated::getAnnotation ( uint32  inKey )

inlineinherited

Get an annotation. Returns an empty annotation if the index doesn't exist.

Definition at line 45 of file Annotated.hpp.

{ return mAnnotations[inKey]; }

Here is the caller graph for this function:

bool torc::physical::ConfigMap::getConfig ( const string &  inSetting, Config &  outConfig  )

inlineinherited

Looks up the specified setting in the map.

Parameters

inSetting	The setting to query.
outConfig	Reference to a configuration to be populated if the setting exists in the map. Default values are used if the setting does not exist.

Note

If this is a special setting with multiple configuration entries, only the first one will be placed in outConfig.

Returns

true if the settings exists in the map, or false otherwise.

Definition at line 82 of file ConfigMap.hpp.

                                                                   {
            // employ friendship status to reach in and reference the config name and value members
            return getConfig(inSetting, outConfig.mName, outConfig.mValue);
        }

Here is the caller graph for this function:

bool torc::physical::ConfigMap::getConfig ( const string &  inSetting, string &  outName, string &  outValue  )

inlineinherited

Looks up the specified setting in the map.

Parameters

inSetting	The setting to query.
outName	Reference to a string to accept the configuration name, or the default name if the setting does not exist.
outValue	Reference to a string to accept the configuration value, or the default value if the setting does not exist.

Note

If this is a special setting with multiple configuration entries, only the first one will be placed in outName and outValue.

Returns

true if the settings exists in the map, or false otherwise.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 95 of file ConfigMap.hpp.

                                                                                   {
            /// \todo Acquire mutex.
            iterator result = find(inSetting);
            if(result == end()) {
                // if the key doesn't exist, return default values
                outName = Config::sConfigDefaultName;
                outValue = Config::sConfigDefaultValue;
                return false;
            } else {
                // otherwise return the config data
                Config& config = result->second;
                outName = config.getName();
                outValue = config.getValue();
                return true;
            }
            /// \todo Release mutex.
        }

Here is the call graph for this function:

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

inlineinherited

Returns the number of configurations in the map.

Definition at line 63 of file ConfigMap.hpp.

{ return super::size(); }

Here is the caller graph for this function:

size_t torc::physical::Circuit::getInstanceCount ( void  ) const

inlineinherited

Returns the number of instances in the circuit.

Definition at line 205 of file Circuit.hpp.

{ return mInstances.size(); }

size_type torc::physical::ConfigMap::getMultiConfigCount ( const string &  inSetting )

inlineinherited

Returns the number of configurations for the given setting.

Definition at line 186 of file ConfigMap.hpp.

{ return count(inSetting); }

Here is the caller graph for this function:

std::pair<iterator, iterator> torc::physical::ConfigMap::getMultiConfigValues ( const string &  inSetting )

inlineinherited

Returns a range that encompasses all of the configurations for the given setting.

Returns

An iterator pair that encompasses all configurations for the setting. Refer to std::pair to determine how to extract the iterators.

Definition at line 183 of file ConfigMap.hpp.

            { return equal_range(inSetting); }

Here is the caller graph for this function:

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:

size_t torc::physical::Circuit::getNetCount ( void  ) const

inlineinherited

Returns the number of nets in the circuit.

Definition at line 215 of file Circuit.hpp.

{ return mNets.size(); }

const SharedPtrType& torc::physical::Progeny< class Circuit >::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 Circuit >::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::Module::getPortCount ( void  ) const

inline

Returns the number of ports in the module.

Definition at line 104 of file Module.hpp.

{ return mPorts.size(); }

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

inlineinherited

Returns a weak pointer to this object.

Definition at line 68 of file Progenitor.hpp.

{ return mSelfWeakPtr; }

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

inlineinherited

Returns a weak pointer to this object.

Definition at line 68 of file Progenitor.hpp.

{ return mSelfWeakPtr; }

bool torc::common::Annotated::hasAnnotation ( uint32  inKey )

inlineinherited

Check if an annotation exists.

Definition at line 51 of file Annotated.hpp.

                                         { 
            return (mAnnotations.find(inKey) != mAnnotations.end());
        }

Here is the caller graph for this function:

bool torc::physical::ConfigMap::hasConfig ( const string &  inSetting ) const

inlineinherited

Returns true if the specified setting exists in the map.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 69 of file ConfigMap.hpp.

                                                      { 
            /// \todo Acquire mutex.
            const_iterator result = find(inSetting);
            return result != end();
            /// \todo Release mutex.
        }

Here is the caller graph for this function:

InstanceSharedPtrConstIterator torc::physical::Circuit::instancesBegin ( void  ) const

inlineinherited

Returns the begin constant iterator for instances.

Definition at line 197 of file Circuit.hpp.

{ return mInstances.begin(); }

Here is the caller graph for this function:

InstanceSharedPtrIterator torc::physical::Circuit::instancesBegin ( void  )

inlineinherited

Returns the begin non-constant iterator for instances.

Definition at line 201 of file Circuit.hpp.

{ return mInstances.begin(); }

InstanceSharedPtrConstIterator torc::physical::Circuit::instancesEnd ( void  ) const

inlineinherited

Returns the end constant iterator for instances.

Definition at line 199 of file Circuit.hpp.

{ return mInstances.end(); }

Here is the caller graph for this function:

InstanceSharedPtrIterator torc::physical::Circuit::instancesEnd ( void  )

inlineinherited

Returns the end non-constant iterator for instances.

Definition at line 203 of file Circuit.hpp.

{ return mInstances.end(); }

NetSharedPtrConstIterator torc::physical::Circuit::netsBegin ( void  ) const

inlineinherited

Returns the begin constant iterator for nets.

Definition at line 207 of file Circuit.hpp.

{ return mNets.begin(); }

Here is the caller graph for this function:

NetSharedPtrIterator torc::physical::Circuit::netsBegin ( void  )

inlineinherited

Returns the begin non-constant iterator for nets.

Definition at line 211 of file Circuit.hpp.

{ return mNets.begin(); }

NetSharedPtrConstIterator torc::physical::Circuit::netsEnd ( void  ) const

inlineinherited

Returns the end constant iterator for nets.

Definition at line 209 of file Circuit.hpp.

{ return mNets.end(); }

Here is the caller graph for this function:

NetSharedPtrIterator torc::physical::Circuit::netsEnd ( void  )

inlineinherited

Returns the end non-constant iterator for nets.

Definition at line 213 of file Circuit.hpp.

{ return mNets.end(); }

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

inline

Equality operator.

This function deems modules equal if their names are identical.

Parameters

rhs	The module to compare against.

Returns

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

Definition at line 110 of file Module.hpp.

{ return mName == rhs.mName; }

PortSharedPtrConstIterator torc::physical::Module::portsBegin ( void  ) const

inline

Returns the begin constant iterator for ports.

Definition at line 96 of file Module.hpp.

{ return mPorts.begin(); }

Here is the caller graph for this function:

PortSharedPtrIterator torc::physical::Module::portsBegin ( void  )

inline

Returns the begin non-constant iterator for ports.

Definition at line 100 of file Module.hpp.

{ return mPorts.begin(); }

PortSharedPtrConstIterator torc::physical::Module::portsEnd ( void  ) const

inline

Returns the end constant iterator for ports.

Definition at line 98 of file Module.hpp.

{ return mPorts.end(); }

Here is the caller graph for this function:

PortSharedPtrIterator torc::physical::Module::portsEnd ( void  )

inline

Returns the end non-constant iterator for ports.

Definition at line 102 of file Module.hpp.

{ return mPorts.end(); }

void torc::common::Annotated::removeAnnotation ( uint32  inKey )

inlineinherited

Remove an annotation.

Definition at line 49 of file Annotated.hpp.

{ mAnnotations.erase(inKey); }

Here is the caller graph for this function:

bool torc::physical::ConfigMap::removeConfig ( const string &  inSetting )

inlineinherited

Removes the named configuration.

Parameters

inSetting

The configuration to remove.

Returns

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

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 145 of file ConfigMap.hpp.

                                                   {
            /// \todo Acquire mutex.
            iterator e = end();
            iterator result = super::find(inSetting);
            if(result == e) return false;
            erase(result);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Circuit::removeInstance ( InstanceSharedPtr &  inInstancePtr )

inlineinherited

Remove an instance from the circuit.

Parameters

inInstancePtr

The instance to remove.

Returns

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

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 109 of file Circuit.hpp.

                                                              {
            /// \todo Acquire mutex.
            const std::string& name = inInstancePtr->getName();
            NameToIndexMap::iterator result = mInstanceMap.find(name);
            NameToIndexMap::iterator e = mInstanceMap.end();
            if(result == e) return false;
            inInstancePtr->resetParentWeakPtr();
            // fix up the map indexes
            NameToIndexMap::mapped_type target = result->second;
            NameToIndexMap::iterator mp = mInstanceMap.begin();
            NameToIndexMap::iterator me = mInstanceMap.end();
            while(mp != me) {
                NameToIndexMap::mapped_type& index = mp->second;
                if(index > target) index--;
                mp++;
            }
            mInstances.erase(mInstances.begin() + target);
            mInstanceMap.erase(result);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Circuit::removeNet ( NetSharedPtr &  inNetPtr )

inlineinherited

Remove a net from the circuit.

Parameters

inNetPtr

The net to remove.

Returns

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

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 166 of file Circuit.hpp.

                                               {
            /// \todo Acquire mutex.
            const std::string& name = inNetPtr->getName();
            NameToIndexMap::iterator result = mNetMap.find(name);
            NameToIndexMap::iterator e = mNetMap.end();
            if(result == e) return false;
            inNetPtr->resetParentWeakPtr();
            // fix up the map indexes
            NameToIndexMap::mapped_type target = result->second;
            NameToIndexMap::iterator mp = mNetMap.begin();
            NameToIndexMap::iterator me = mNetMap.end();
            while(mp != me) {
                NameToIndexMap::mapped_type& index = mp->second;
                if(index > target) index--;
                mp++;
            }
            mNets.erase(mNets.begin() + target);
            mNetMap.erase(result);
            /// \todo Release mutex.
            return true;
        }

bool torc::physical::Module::removePort ( PortSharedPtr &  inPortPtr )

inline

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 80 of file Module.hpp.

                                                  {
            /// \todo Acquire mutex.
            PortSharedPtrIterator e = portsEnd();
            PortSharedPtrIterator result = findPort(inPortPtr->getName());
            if(result == e) return false;
            mPorts.erase(result);
            /// \todo Release mutex.
            return true;
        }

Here is the call graph for this function:

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

inlineinherited

Method to reset and orphan this object.

Definition at line 51 of file Progeny.hpp.

{ mParentWeakPtr.reset(); }

void torc::physical::Module::setAnchor ( const string &  inAnchor )

inline

Sets the anchor instance name for this module.

Definition at line 93 of file Module.hpp.

{ mAnchor = inAnchor; }

void torc::common::Annotated::setAnnotation ( uint32  inKey, boost::any  inValue  )

inlineinherited

Set an annotation.

Definition at line 47 of file Annotated.hpp.

{ mAnnotations[inKey] = inValue; }

Here is the caller graph for this function:

void torc::physical::ConfigMap::setConfig ( const string &  inSetting, const Config &  inConfig  )

inlineinherited

Sets the configuration for the given setting.

If this is a regular setting, then any existing configuration for the setting will be replaced, but if this is a special setting for which multiple configurations are allowed, it will be added to the map alongside the existing configurations.

Parameters

inSetting	The setting of interest.
inConfig	The configuration to set.

Definition at line 119 of file ConfigMap.hpp.

                                                                        {
            setConfig(inSetting, inConfig.getName(), inConfig.getValue());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::physical::ConfigMap::setConfig ( const string &  inSetting, const string &  inName, const string &  inValue  )

inlineinherited

Sets the configuration for the given setting.

If this is a regular setting, then any existing configuration for the setting will be replaced, but if this is a special setting for which multiple configurations are allowed, it will be added to the map alongside the existing configurations.

Parameters

inSetting	The setting of interest.
inName	The configuration name to set.
inValue	The configuration value to set.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 130 of file ConfigMap.hpp.

                                                                                             {
            /// \todo Acquire mutex.
            // if duplicates are disallowed for this setting, erase any matching entries
            if(!allowConfigDuplicates(inSetting)) {
                std::pair<iterator, iterator> range = equal_range(inSetting);
                if(range.first != range.second) erase(range.first, range.second);
            }
            // insert the config entry
            insert(make_pair(inSetting, Config(inName, inValue, mNextSequenceIndex++)));
            /// \todo Release mutex.
        }

Here is the call graph for this function:

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

inlineinherited

Sets the weak pointer to the parent.

Definition at line 49 of file Progeny.hpp.

{ mParentWeakPtr = inParentPtr; }

Here is the caller graph for this function:

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

inlineprotectedinherited

Sets the weak pointer to this object.

Definition at line 59 of file Progenitor.hpp.

{ mSelfWeakPtr = inSelfPtr; }

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

inlineprotectedinherited

Sets the weak pointer to this object.

Definition at line 59 of file Progenitor.hpp.

{ mSelfWeakPtr = inSelfPtr; }

void torc::physical::Circuit::unplace ( void  )

inlineinherited

Unplace the circuit by discarding placement information for each instance.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 131 of file Circuit.hpp.

                           {
            /// \todo Acquire mutex.
            InstanceSharedPtrIterator p = instancesBegin();
            InstanceSharedPtrIterator e = instancesEnd();
            while(p < e) (*p++)->unplace();
            /// \todo Release mutex.
        }

Here is the call graph for this function:

void torc::physical::Circuit::unroute ( void  )

inlineinherited

Unroute the circuit by discarding routing information for each net.

Todo:

Acquire mutex.

Todo:

Release mutex.

Definition at line 188 of file Circuit.hpp.

                           {
            /// \todo Acquire mutex.
            NetSharedPtrIterator p = netsBegin();
            NetSharedPtrIterator e = netsEnd();
            while(p < e) (*p++)->unroute();
            /// \todo Release mutex.
        }

Here is the call graph for this function:

Friends And Related Function Documentation

friend class Factory

friend

The Factory class has direct access to our internals.

Definition at line 36 of file Module.hpp.

Field Documentation

string torc::physical::Module::mAnchor

protected

The module anchor instance name.

Definition at line 43 of file Module.hpp.

boost::unordered_map<boost::uint32_t, boost::any> torc::common::Annotated::mAnnotations

protectedinherited

Map containing any annotations.

Definition at line 34 of file Annotated.hpp.

NameToIndexMap torc::physical::Circuit::mInstanceMap

protectedinherited

Instance name to index mapping for this circuit.

Definition at line 60 of file Circuit.hpp.

InstanceSharedPtrVector torc::physical::Circuit::mInstances

protectedinherited

Vector of Instance shared pointers for the circuit.

Definition at line 58 of file Circuit.hpp.

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

NameToIndexMap torc::physical::Circuit::mNetMap

protectedinherited

Net name to index mapping for this circuit.

Definition at line 64 of file Circuit.hpp.

NetSharedPtrVector torc::physical::Circuit::mNets

protectedinherited

Vector of Net shared pointers for the circuit.

Definition at line 62 of file Circuit.hpp.

SequenceIndex torc::physical::ConfigMap::mNextSequenceIndex

protectedinherited

Sequence index to use for the next configuration added to this map.

Definition at line 48 of file ConfigMap.hpp.

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

protectedinherited

Weak pointer to the parent.

Definition at line 38 of file Progeny.hpp.

PortSharedPtrVector torc::physical::Module::mPorts

protected

Vector of Port shared pointers for the module.

Definition at line 45 of file Module.hpp.

WeakPtrType torc::physical::Progenitor< class Circuit >::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.

WeakPtrType torc::physical::Progenitor< Module >::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:

• Module.hpp