torc::router::RouterHeuristicBase Class Reference

Provides the interface for net routers. More...

#include <RouterHeuristicBase.hpp>

Inheritance diagram for torc::router::RouterHeuristicBase:

Collaboration diagram for torc::router::RouterHeuristicBase:

Public Member Functions
	RouterHeuristicBase (DDB &inDB)
	Public Constructor. More...
virtual	~RouterHeuristicBase ()
	Destructor. More...
boost::any	getParameter (boost::uint32_t index)
	Get a parameter. More...
void	setParameter (boost::uint32_t index, boost::any inParameter)
	Set a parameter. More...
virtual void	processParameters ()
	Do something with the parameters. More...

Protected Attributes
DDB &	mDB
	Database reference. More...
ParameterMap	mParameters
	Parameter map. More...

Private Types
typedef architecture::DDB	DDB
	Imported type names. More...
typedef boost::unordered_map < boost::uint32_t, boost::any >	ParameterMap

Detailed Description

Provides the interface for net routers.

Definition at line 31 of file RouterHeuristicBase.hpp.

Member Typedef Documentation

typedef architecture::DDB torc::router::RouterHeuristicBase::DDB

private

Imported type names.

Definition at line 34 of file RouterHeuristicBase.hpp.

typedef boost::unordered_map<boost::uint32_t, boost::any> torc::router::RouterHeuristicBase::ParameterMap

private

Definition at line 35 of file RouterHeuristicBase.hpp.

Constructor & Destructor Documentation

torc::router::RouterHeuristicBase::RouterHeuristicBase ( DDB &  inDB )

inline

Public Constructor.

Definition at line 47 of file RouterHeuristicBase.hpp.

: mDB(inDB) {}

virtual torc::router::RouterHeuristicBase::~RouterHeuristicBase ( )

inlinevirtual

Destructor.

Definition at line 49 of file RouterHeuristicBase.hpp.

{}

Member Function Documentation

boost::any torc::router::RouterHeuristicBase::getParameter ( boost::uint32_t  index )

inline

Get a parameter.

Definition at line 52 of file RouterHeuristicBase.hpp.

                                                   {
            ParameterMap::iterator p = mParameters.find(index);
            if (p != mParameters.end()) {
                return p->second;
            }
            return boost::any();
        }

Here is the caller graph for this function:

virtual void torc::router::RouterHeuristicBase::processParameters ( )

inlinevirtual

Do something with the parameters.

Reimplemented in torc::router::PathFinderNetRouterHeuristic.

Definition at line 64 of file RouterHeuristicBase.hpp.

{}

Here is the caller graph for this function:

void torc::router::RouterHeuristicBase::setParameter ( boost::uint32_t  index, boost::any  inParameter  )

inline

Set a parameter.

Definition at line 60 of file RouterHeuristicBase.hpp.

                                                                     {
            mParameters[index] = inParameter;
        }

Here is the caller graph for this function:

Field Documentation

DDB& torc::router::RouterHeuristicBase::mDB

protected

Database reference.

Definition at line 40 of file RouterHeuristicBase.hpp.

ParameterMap torc::router::RouterHeuristicBase::mParameters

protected

Parameter map.

Definition at line 42 of file RouterHeuristicBase.hpp.

---

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

• RouterHeuristicBase.hpp