torc-master: torc::physical::Net Class Reference

torc::common::Annotated::mAnnotations

string mName

The name of the object.

Definition: Named.hpp:43

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.

45 { return mAnnotations[inKey]; }

boost::unordered_map< boost::uint32_t, boost::any > mAnnotations

Map containing any annotations.

Definition: Annotated.hpp:34

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.

63 { return super::size(); }

Here is the caller graph for this function:

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.

186 { 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.

184 { 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.

51 { return mName; }

torc::physical::Net::mNetType

string mName

The name of the object.

Definition: Named.hpp:43

Here is the caller graph for this function:

ENetType torc::physical::Net::getNetType ( void ) const

inline

Returns the net power type. See ENetPowerType.

Definition at line 217 of file physical/Net.hpp.

217 { return mNetType; }

ENetType mNetType

The net power type. See ENetType.

Definition: physical/Net.hpp:53

Here is the caller graph for this function:

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.

59 { return mParentWeakPtr.lock(); }

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

WeakPtrType mParentWeakPtr

Weak pointer to the parent.

Definition: Progeny.hpp:38

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.

47 { return mParentWeakPtr; }

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

WeakPtrType mParentWeakPtr

Weak pointer to the parent.

Definition: Progeny.hpp:38

size_t torc::physical::Net::getPipCount ( void ) const

inline

Returns the number of pips on the net.

Definition at line 185 of file physical/Net.hpp.

185 { return mPips.size(); }

torc::physical::Progenitor< Net >::mSelfWeakPtr

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

Here is the caller graph for this function:

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

inlineinherited

Returns a weak pointer to this object.

Definition at line 68 of file Progenitor.hpp.

68 { return mSelfWeakPtr; }

WeakPtrType mSelfWeakPtr

Weak pointer this object.

Definition: Progenitor.hpp:57

size_t torc::physical::Net::getSinkCount ( void ) const

inline

Returns the number of sinks on the net.

Definition at line 181 of file physical/Net.hpp.

181 { return mSinks.size(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

Here is the caller graph for this function:

size_t torc::physical::Net::getSourceCount ( void ) const

inline

Returns the number of sources on the net.

Definition at line 173 of file physical/Net.hpp.

173 { return mSources.size(); }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

Here is the caller graph for this function:

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::Net::hasAnyPips ( void ) const

inline

Returns true if the net has any pips.

Definition at line 183 of file physical/Net.hpp.

183 { return !mPips.empty(); }

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

Here is the caller graph for this function:

bool torc::physical::Net::hasAnySinks ( void ) const

inline

Returns true if the net has any sinks.

Definition at line 175 of file physical/Net.hpp.

175 { return !mSinks.empty(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

bool torc::physical::Net::hasAnySources ( void ) const

inline

Returns true if the net has any sources.

Definition at line 167 of file physical/Net.hpp.

167 { return !mSources.empty(); }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

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:

bool torc::physical::Net::hasMultipleSinks ( void ) const

inline

Returns true if the next has more than one sink.

Definition at line 179 of file physical/Net.hpp.

179 { return mSinks.size() > 1; }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

bool torc::physical::Net::hasMultipleSources ( void ) const

inline

Returns true if the net has more than one source.

Definition at line 171 of file physical/Net.hpp.

171 { return mSources.size() > 1; }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

bool torc::physical::Net::hasOneSink ( void ) const

inline

Returns true if the net has exactly one sink.

Definition at line 177 of file physical/Net.hpp.

177 { return mSinks.size() == 1; }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

bool torc::physical::Net::hasOneSource ( void ) const

inline

Returns true if the net has exactly one source.

Definition at line 169 of file physical/Net.hpp.

169 { return mSources.size() == 1; }

torc::physical::Net::hasAnyPips

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

bool torc::physical::Net::isRouted ( void ) const

inline

Returns true if the net has any pips.

Definition at line 187 of file physical/Net.hpp.

187 { return hasAnyPips(); }

bool hasAnyPips(void) const

Returns true if the net has any pips.

Definition: physical/Net.hpp:183

Here is the call graph for this function:

bool torc::physical::Net::isUnrouted ( void ) const

inline

Returns true if the net has no pips.

Definition at line 189 of file physical/Net.hpp.

189 { return !hasAnyPips(); }

torc::physical::Net::hasAnyPips

bool hasAnyPips(void) const

Returns true if the net has any pips.

Definition: physical/Net.hpp:183

Here is the call graph for this function:

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

inlineinherited

Equality operator.

Definition at line 54 of file Named.hpp.

54 { return mName == rhs.mName; }

string mName

The name of the object.

Definition: Named.hpp:43

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

inline

Equality operator.

This function deems nets equal if their names are identical.

Parameters

rhs	The net to compare against.

Returns: true if both net names are identical, or false otherwise.

Definition at line 225 of file physical/Net.hpp.

225 { return mName == rhs.mName; }

string mName

The name of the object.

Definition: Named.hpp:43

PipConstIterator torc::physical::Net::pipsBegin ( void ) const

inline

Returns the begin constant iterator for pips.

Definition at line 208 of file physical/Net.hpp.

208 { return mPips.begin(); }

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

Here is the caller graph for this function:

PipIterator torc::physical::Net::pipsBegin ( void )

inline

Returns the begin non-constant iterator for pips.

Definition at line 212 of file physical/Net.hpp.

212 { return mPips.begin(); }

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

PipConstIterator torc::physical::Net::pipsEnd ( void ) const

inline

Returns the end constant iterator for pips.

Definition at line 210 of file physical/Net.hpp.

210 { return mPips.end(); }

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

Here is the caller graph for this function:

PipIterator torc::physical::Net::pipsEnd ( void )

inline

Returns the end non-constant iterator for pips.

Definition at line 214 of file physical/Net.hpp.

214 { return mPips.end(); }

torc::common::Annotated::mAnnotations

PipVector mPips

Vector of pips for the net.

Definition: physical/Net.hpp:59

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

inlineinherited

Remove an annotation.

Definition at line 49 of file Annotated.hpp.

49 { mAnnotations.erase(inKey); }

boost::unordered_map< boost::uint32_t, boost::any > mAnnotations

Map containing any annotations.

Definition: Annotated.hpp:34

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::Net::removePip ( const Pip & inPip )

inline

Removes the given pip from this net.

Returns: true if the pip was removed from this net, or false if it was not found.

Todo:: Acquire mutex.

Todo:: Release mutex.

Definition at line 148 of file physical/Net.hpp.

                                          {
             /// \todo Acquire mutex.
             // look up the pip
             PipIterator e = pipsEnd();
             PipIterator result = std::find(pipsBegin(), e, inPip);
             // do nothing if the pip doesn't exist
             if(result == e) return false;
             // erase the pip
             mPips.erase(result);
             /// \todo Release mutex.
             return true;
         }

Here is the call graph for this function:

bool torc::physical::Net::removeSink ( InstancePinSharedPtr & inInstancePinPtr )

inline

Removes the given instance pin from the sinks of this net.

Returns: true if the instance pin was removed from the sink list, or false if it was not found.

Todo:: Acquire mutex.

Todo:: Release mutex.

Definition at line 128 of file physical/Net.hpp.

                                                                 {
             /// \todo Acquire mutex.
             InstancePinSharedPtrIterator e = sinksEnd();
             InstancePinSharedPtrIterator result = std::find(sinksBegin(), e, inInstancePinPtr);
             if(result == e) return false;
             inInstancePinPtr->removeFromInstance();
             mSinks.erase(result);
             /// \todo Release mutex.
             return true;
         }

Here is the call graph for this function:

bool torc::physical::Net::removeSource ( InstancePinSharedPtr & inInstancePinPtr )

inline

Removes the given instance pin from the sources of this net.

Returns: true if the instance pin was removed from the source list, or false if it was not found.

Todo:: Acquire mutex.

Todo:: Release mutex.

Definition at line 115 of file physical/Net.hpp.

                                                                   {
             /// \todo Acquire mutex.
             InstancePinSharedPtrIterator e = sourcesEnd();
             InstancePinSharedPtrIterator result = std::find(sourcesBegin(), e, inInstancePinPtr);
             if(result == e) return false;
             inInstancePinPtr->removeFromInstance();
             mSources.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.

51 { mParentWeakPtr.reset(); }

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

WeakPtrType mParentWeakPtr

Weak pointer to the parent.

Definition: Progeny.hpp:38

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

inlineinherited

Set an annotation.

Definition at line 47 of file Annotated.hpp.

47 { mAnnotations[inKey] = inValue; }

torc::common::Annotated::mAnnotations

boost::unordered_map< boost::uint32_t, boost::any > mAnnotations

Map containing any annotations.

Definition: Annotated.hpp:34

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::Renamable< Circuit >::setName ( const string & inName )

inlineprotectedinherited

Sets the object name.

Definition at line 52 of file physical/Renamable.hpp.

52 { mName = inName; }

torc::physical::Net::mNetType

string mName

The name of the object.

Definition: Named.hpp:43

void torc::physical::Net::setNetType ( ENetType inNetType )

inline

Sets the net power type. See ENetPowerType.

Definition at line 219 of file physical/Net.hpp.

219 { mNetType = inNetType; }

ENetType mNetType

The net power type. See ENetType.

Definition: physical/Net.hpp:53

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.

49 { mParentWeakPtr = inParentPtr; }

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

WeakPtrType mParentWeakPtr

Weak pointer to the parent.

Definition: Progeny.hpp:38

Here is the caller graph for this function:

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

inlineprotectedinherited

Sets the weak pointer to this object.

Definition at line 59 of file Progenitor.hpp.

59 { mSelfWeakPtr = inSelfPtr; }

torc::physical::Progenitor< Net >::mSelfWeakPtr

WeakPtrType mSelfWeakPtr

Weak pointer this object.

Definition: Progenitor.hpp:57

InstancePinSharedPtrConstIterator torc::physical::Net::sinksBegin ( void ) const

inline

Returns the begin constant iterator for sink instance pins.

Definition at line 200 of file physical/Net.hpp.

200 { return mSinks.begin(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

Here is the caller graph for this function:

InstancePinSharedPtrIterator torc::physical::Net::sinksBegin ( void )

inline

Returns the begin non-constant iterator for sink instance pins.

Definition at line 204 of file physical/Net.hpp.

204 { return mSinks.begin(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

InstancePinSharedPtrConstIterator torc::physical::Net::sinksEnd ( void ) const

inline

Returns the end constant iterator for sink instance pins.

Definition at line 202 of file physical/Net.hpp.

202 { return mSinks.end(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

Here is the caller graph for this function:

InstancePinSharedPtrIterator torc::physical::Net::sinksEnd ( void )

inline

Returns the end non-constant iterator for sink instance pins.

Definition at line 206 of file physical/Net.hpp.

206 { return mSinks.end(); }

InstancePinSharedPtrVector mSinks

Vector of instance pin shared pointer sinks for the net.

Definition: physical/Net.hpp:57

InstancePinSharedPtrConstIterator torc::physical::Net::sourcesBegin ( void ) const

inline

Returns the begin constant iterator for source instance pins.

Definition at line 192 of file physical/Net.hpp.

192 { return mSources.begin(); }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

Here is the caller graph for this function:

InstancePinSharedPtrIterator torc::physical::Net::sourcesBegin ( void )

inline

Returns the begin non-constant iterator for source instance pins.

Definition at line 196 of file physical/Net.hpp.

196 { return mSources.begin(); }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

InstancePinSharedPtrConstIterator torc::physical::Net::sourcesEnd ( void ) const

inline

Returns the end constant iterator for source instance pins.

Definition at line 194 of file physical/Net.hpp.

194 { return mSources.end(); }

InstancePinSharedPtrVector mSources

Vector of instance pin shared pointer sources for the net.

Definition: physical/Net.hpp:55

Here is the caller graph for this function:

InstancePinSharedPtrIterator torc::physical::Net::sourcesEnd ( void )

inline

Returns the end non-constant iterator for source instance pins.

Definition at line 198 of file physical/Net.hpp.

198 { return mSources.end(); }