torc::router::RouterHeuristicBase Class Reference

Provides the interface for net routers. More...

#include <RouterHeuristicBase.hpp>

Inheritance diagram for torc::router::RouterHeuristicBase:

[legend]

Collaboration diagram for torc::router::RouterHeuristicBase:

[legend]

List of all members.

Public Member Functions
	RouterHeuristicBase (DDB &inDB)
	Public Constructor.
virtual	~RouterHeuristicBase ()
	Destructor.
boost::any	getParameter (boost::uint32_t index)
	Get a parameter.
void	setParameter (boost::uint32_t index, boost::any inParameter)
	Set a parameter.
virtual void	processParameters ()
	Do something with the parameters.
Protected Attributes
DDB &	mDB
	Database reference.
ParameterMap	mParameters
	Parameter map.
Private Types
typedef architecture::DDB	DDB
	Imported type names.
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.

Reimplemented in torc::router::NetRouterHeuristic, torc::router::NetRouterHeuristicBase, torc::router::NetVectorRouterHeuristicBase, torc::router::PathFinderHeuristic, and torc::router::PathFinderNetRouterHeuristic.

Definition at line 34 of file RouterHeuristicBase.hpp.

---

Constructor & Destructor Documentation

torc::router::RouterHeuristicBase::RouterHeuristicBase

(

DDB &

inDB

)

[inline]

Public Constructor.

Definition at line 47 of file RouterHeuristicBase.hpp.

virtual torc::router::RouterHeuristicBase::~RouterHeuristicBase

(

)

[inline, virtual]

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.

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

Set a parameter.

Definition at line 60 of file RouterHeuristicBase.hpp.

virtual void torc::router::RouterHeuristicBase::processParameters

(

)

[inline, virtual]

Do something with the parameters.

Reimplemented in torc::router::PathFinderNetRouterHeuristic.

Definition at line 64 of file RouterHeuristicBase.hpp.

---

Member Data 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:

• torc/router/RouterHeuristicBase.hpp