jccl::DepChecker Class Reference

Base class for dependency checkers. More...

#include <jccl/RTRC/DepChecker.h>

List of all members.

Public Member Functions
	DepChecker ()
	Constructor.
virtual	~DepChecker ()
	Destructor.
virtual std::string	getCheckerName ()
	Return a string name for the checker.
virtual bool	canHandle (ConfigElementPtr element)
	Checks if this DepChecker knows how to handle element.
virtual bool	depSatisfied (ConfigElementPtr element)
	Checks if element's dependencies are satisfied.
virtual void	debugOutDependencies (ConfigElementPtr element, int dbgLevel=vprDBG_WARNING_LVL)
	Write element's dependencies to vprDEBUG.

---

Detailed Description

Base class for dependency checkers.

A dependency checker is responsible for figuring out if the system has all the required dependencies filled for a given jccl::ConfigElement.

This class also implements a default behavior for dependency checkers, which just looks at any jccl::ConfigElement pointer properties in the given element and returns true if all the elements named by those properties exist in the ConfigManager's current configuration.

Configuration information with special dependency requirements should specialize this class and register an instance with the Dependency Manager.

Note:

The DepChecker must be registered BEFORE a element of the given type is checked for dependencies.

Definition at line 62 of file DepChecker.h.

---

Constructor & Destructor Documentation

jccl::DepChecker::DepChecker

(

)

Constructor.

Definition at line 42 of file DepChecker.cpp.

{;}

virtual jccl::DepChecker::~DepChecker

(

)

[inline, virtual]

Destructor.

Definition at line 69 of file DepChecker.h.

   {;}

---

Member Function Documentation

std::string jccl::DepChecker::getCheckerName

(

)

[virtual]

Return a string name for the checker.

This is used to output messages in checker listings.

Definition at line 45 of file DepChecker.cpp.

Referenced by jccl::DependencyManager::registerChecker().

{
   return std::string("Default Checker");
}

bool jccl::DepChecker::canHandle

(

ConfigElementPtr

element

)

[virtual]

Checks if this DepChecker knows how to handle element.

Returns:

true if we understand the element. The default behavior returns true (the default checker can check anything).

Definition at line 50 of file DepChecker.cpp.

{
   boost::ignore_unused_variable_warning(element);
   return true;
}

bool jccl::DepChecker::depSatisfied

(

ConfigElementPtr

element

)

[virtual]

Checks if element's dependencies are satisfied.

Returns:

true iff element's dependencies are satisfied.

Definition at line 56 of file DepChecker.cpp.

References jccl::ConfigManager::isElementInActiveList().

{
   bool pass = true;

   ConfigManager* cfg_mgr = ConfigManager::instance();

   // Get the list of dependencies
   std::vector<std::string> dependencies =
      element->getElementPtrDependencies();

   // Check to see if they are loaded already
   for (unsigned int i = 0 ; i < dependencies.size() ; i++)
   {
      if (!cfg_mgr->isElementInActiveList(dependencies[i]))
      {
         pass = false;
      }
   }
   return pass;
}

void jccl::DepChecker::debugOutDependencies	(	ConfigElementPtr	element,
		int	dbgLevel = vprDBG_WARNING_LVL
	)			[virtual]

Write element's dependencies to vprDEBUG.

Parameters:

	element	The element whose dependencies will be printed.
	dbgLevel	Output priority level for vprDEBUG.

Definition at line 78 of file DepChecker.cpp.

References jccl::ConfigManager::isElementInActiveList().

{
   vprDEBUG_NEXT_BEGIN(vprDBG_ALL,dbg_lvl)
      << "---- Dependencies for " << element->getName()
      << " (type: " << element->getID() << ") ----\n" << vprDEBUG_FLUSH;

   ConfigManager* cfg_mgr = ConfigManager::instance();

   // Get the list of dependencies
   std::vector<std::string> dependencies = element->getElementPtrDependencies();

   // Check to see if they are loaded already
   for (unsigned int i = 0 ; i < dependencies.size() ; i++)
   {
      vprDEBUG_NEXT(vprDBG_ALL,dbg_lvl) << i << ": "
          << dependencies[i].c_str()
          << " ==> " << vprDEBUG_FLUSH;
      if (!cfg_mgr->isElementInActiveList(dependencies[i]))
      {
         vprDEBUG_CONT(vprDBG_ALL,dbg_lvl) << "not available.\n" << vprDEBUG_FLUSH;
      }
      else
      {
         vprDEBUG_CONT(vprDBG_ALL,dbg_lvl) << "passed.\n" << vprDEBUG_FLUSH;
      }
   }

   vprDEBUG_CONT_END(vprDBG_ALL,dbg_lvl) << std::endl << vprDEBUG_FLUSH;

}

---

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

• DepChecker.h
• DepChecker.cpp

---