jccl::DependencyManager Class Reference

A dependency checker for dynamically added components. More...

#include <jccl/RTRC/DependencyManager.h>

Collaboration diagram for jccl::DependencyManager:

[legend]List of all members.

Public Member Functions
void	registerChecker (DepChecker *checker)
	Registers a new dependency checker.
bool	isSatisfied (ConfigElementPtr element)
	Checks if dependencies are satisfied for the given element.
void	debugOutDependencies (ConfigElementPtr element, int dbg_lvl)
	Prints information about element's dependencies.
Private Member Functions
	DependencyManager ()
	Constructor.
DepChecker *	findDepChecker (ConfigElementPtr element)
	Finds a DepChecker that can handle element.
void	debugDump ()
	Prints information about the DependencyManager's state to vprDEBUG.
	vprSingletonHeader (DependencyManager)
Private Attributes
std::vector< DepChecker * >	mDepCheckers
	List of dependency checkers.
DepChecker	mDefaultChecker
	Default dependency checker.

---

Detailed Description

A dependency checker for dynamically added components.

The Dependency Manager works in conjunction with the Config Manager, and checks for dependencies for any configuration add request. The default behavior is to simply check the Config Manager's active list for all jccl::ConfigElement objects that the request's jccl::ConfigElement refers to. However, additional DepCheckers can be registered to provide specialized functionality.

Note that this class is a singleton, primarily so that the master list of DepCheckers can be appended to by any entity in the system.

See also:

jccl::ConfigManager

Definition at line 61 of file DependencyManager.h.

---

Constructor & Destructor Documentation

jccl::DependencyManager::DependencyManager

(

)

[private]

Constructor.

Private since this is a singleton.

Definition at line 47 of file DependencyManager.cpp.

References mDepCheckers.

                                    : mDepCheckers(), mDefaultChecker()
{
   mDepCheckers = std::vector<DepChecker*>(0);
   //debugDump();
}

---

Member Function Documentation

void jccl::DependencyManager::registerChecker

(

DepChecker *

checker

)

Registers a new dependency checker.

Definition at line 54 of file DependencyManager.cpp.

References debugDump(), jccl::DepChecker::getCheckerName(), jcclDBG_RECONFIG(), and mDepCheckers.

{
   vprASSERT(checker != NULL);
   mDepCheckers.push_back(checker);       // Add the checker to the list
   vprDEBUG(jcclDBG_RECONFIG, vprDBG_CONFIG_LVL)
      << "DependencyManager: Registered: "
      << std::setiosflags(std::ios::right) << std::setw(25)
      << std::setfill(' ') << checker->getCheckerName().c_str()
      << std::resetiosflags(std::ios::right)
      << "  type: " << typeid(*checker).name() << std::endl
      << vprDEBUG_FLUSH;
   debugDump();
}

bool jccl::DependencyManager::isSatisfied

(

ConfigElementPtr

element

)

Checks if dependencies are satisfied for the given element.

Returns:

true iff dependencies for element are satisfied.

Definition at line 69 of file DependencyManager.cpp.

References findDepChecker().

Referenced by jccl::ConfigElementHandler::configProcessPending(), and jccl::ConfigManager::scanForLostDependencies().

{
   vprASSERT(NULL != element.get());
   DepChecker* checker = findDepChecker(element);
   return checker->depSatisfied(element);
}

void jccl::DependencyManager::debugOutDependencies	(	ConfigElementPtr	element,
		int	dbg_lvl
	)

Prints information about element's dependencies.

Definition at line 77 of file DependencyManager.cpp.

References findDepChecker().

Referenced by jccl::ConfigElementHandler::configProcessPending().

{
   vprASSERT(NULL != element.get());
   DepChecker* checker = findDepChecker(element);
   checker->debugOutDependencies(element,dbg_lvl);
}

DepChecker * jccl::DependencyManager::findDepChecker

(

ConfigElementPtr

element

)

[private]

Finds a DepChecker that can handle element.

DepCheckers list the jccl::ConfigElement types that they know how to handle; this is checked versus element.getDefToken().

Returns:

A DepChecker that knows how to handle element. If no specific checker is found, the default checker is returned. If multiple specific DepCheckers claim to be able to handle element, the choice is implementation dependent.

Definition at line 86 of file DependencyManager.cpp.

References mDefaultChecker, and mDepCheckers.

Referenced by debugOutDependencies(), and isSatisfied().

{
   vprASSERT(NULL != element.get());

   //std::string element_type;
   //element_type = (std::string)element->getType();

   for(unsigned int i=0;i<mDepCheckers.size();i++)
   {
      // Get next constructor
      DepChecker* checker = mDepCheckers[i];
      vprASSERT(checker != NULL);

      if(checker->canHandle(element))
      {
         return checker;
      }
   }

   return &mDefaultChecker;
}

void jccl::DependencyManager::debugDump

(

)

[private]

Prints information about the DependencyManager's state to vprDEBUG.

Definition at line 109 of file DependencyManager.cpp.

References jcclDBG_RECONFIG(), and mDepCheckers.

Referenced by registerChecker().

{
   //vprDEBUG_BEGIN(jcclDBG_RECONFIG, jcclDBG_CONFIG_LVL) << "DependencyManager::debugDump\n" << vprDEBUG_FLUSH;
   vprDEBUG_BEGIN(jcclDBG_RECONFIG, vprDBG_STATE_LVL)
      << "----- Current dependency checkers -----\n" << vprDEBUG_FLUSH;
   vprDEBUG_NEXT(jcclDBG_RECONFIG, vprDBG_STATE_LVL)
      << "num checkers:" << mDepCheckers.size() << "\n"
      << vprDEBUG_FLUSH;
   vprDEBUG_NEXT(jcclDBG_RECONFIG, vprDBG_STATE_LVL)
      << "-1: Checker: default   type: default checker  recog: all (this is a fallback)\n"
      << vprDEBUG_FLUSH;

   for(unsigned int cNum=0;cNum<mDepCheckers.size();cNum++)
   {
      DepChecker* checker = mDepCheckers[cNum];
      vprDEBUG_NEXT(jcclDBG_RECONFIG, vprDBG_STATE_LVL)
         << cNum << ": Checker:" << (void*)checker
         << "   type:" << typeid(*checker).name()
         << "   recog:" << checker->getCheckerName().c_str()
         << "\n" << vprDEBUG_FLUSH;
   }

   vprDEBUG_END(jcclDBG_RECONFIG, vprDBG_STATE_LVL)
      << "---------------------\n" << vprDEBUG_FLUSH;
}

jccl::DependencyManager::vprSingletonHeader

(

DependencyManager

)

[private]

---

Member Data Documentation

std::vector<DepChecker*> jccl::DependencyManager::mDepCheckers [private]

List of dependency checkers.

Definition at line 99 of file DependencyManager.h.

Referenced by debugDump(), DependencyManager(), findDepChecker(), and registerChecker().

DepChecker jccl::DependencyManager::mDefaultChecker [private]

Default dependency checker.

Definition at line 102 of file DependencyManager.h.

Referenced by findDepChecker().

---

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

• DependencyManager.h
• DependencyManager.cpp

---