JobCPathRegistry.cxx

Go to the documentation of this file.

// $Id: JobCPathRegistry.cxx,v 1.9 2009/02/28 21:46:13 gmieg Exp $
//
// A class to manage and store job paths
//
// messier@huhepl.harvard.edu
#include "JobControl/JobCPathRegistry.h"
#include "MessageService/MsgService.h"
#include "JobControl/JobCPath.h"

#include <cassert>
#include <cstring> // strcmp()

using namespace std;

CVSID("$Id: JobCPathRegistry.cxx,v 1.9 2009/02/28 21:46:13 gmieg Exp $");

//......................................................................

JobCPathRegistry::JobCPathRegistry()
{ 
  // Initially make room for 10 paths
  fPathList.reserve(10);
}

//......................................................................

JobCPathRegistry::~JobCPathRegistry() 
{
//======================================================================
// Purpose: Delete the paths held by this class
//======================================================================
  std::vector<JobCPath*>::iterator itrPath(fPathList.begin());
  std::vector<JobCPath*>::iterator itrEnd(fPathList.end());
  for (; itrPath != itrEnd; ++itrPath) {
    delete (*itrPath);
  }
}

//......................................................................

JobCModule* JobCPathRegistry::LookUpModule(const char* module) const 
{
//======================================================================
// Purpose: Look up a named module in all the existing paths
//
// Input:   mod - The name of the module to look up
//
// Returns: Pointer to the specified job module or 0 if a module with
//          this name cannot be found or there are two modules that 
//          match this name.
//======================================================================

  // Require exactly one match to module name
  int nmatch = 0;                      // Number of matches found
  JobCModule* jmtry;                   // a path that matches
  JobCModule* jm;                      // last match in list
  
  // Loop over paths looking for modules in them
  jmtry = 0;
  jm    = 0;
  vector<JobCPath*>::const_iterator itrPath(fPathList.begin());
  vector<JobCPath*>::const_iterator itrEnd(fPathList.end());
  for (; itrPath != itrEnd; ++itrPath) {
    jmtry = (*itrPath)->GetModule(module);
    if (jmtry!=0) {
      jm = jmtry;
      MSG("JobC",Msg::kVerbose) << 
        "Found " << module << " in path " << (*itrPath)->GetName() << "\n";
      ++nmatch;
    }
  }
  
  // Check return conditions -- search is sucessful if exactly one
  // module was found
  // Unique match
  if (nmatch == 1) {
    // Success - return the last (and only) match in the path
    return jm;
  }
  else if (nmatch > 1) {
    // Too many matches
    MSG("JobC",Msg::kWarning) << 
      "Module specification not unique!\n" <<
      " '" << module << "' matches " << nmatch << " possible modules.\n" <<
      " Please specify the path name for the module you want, eg:\n" <<
      " /[path_name]/[module_name]" << endl;
    return 0;
  }

  // Module not found -- fall through to here
  return 0;
}

//......................................................................

JobCPath* JobCPathRegistry::LookUpPath(const char* path) const
{
//======================================================================
// Purpose: Loop over existing paths looking for one called "path"
//
// Returns: Pointer to the path if found
//          0 - no matching path found
//======================================================================
  // Creation of duplicate path names is not allowed by MakePath, so
  // don't bother checking here.
  std::vector<JobCPath*>::const_iterator itrPath(fPathList.begin());
  std::vector<JobCPath*>::const_iterator itrEnd(fPathList.end());
  for (; itrPath != itrEnd; ++itrPath) {
    if (strcmp(path,(*itrPath)->GetName())==0) {
      return (*itrPath);
    }
  }
  return 0;
}

//......................................................................

JobCPath* JobCPathRegistry::MakePath(const char*      name, 
                                     MomNavigator*    mom, 
                                     JobCInputModule* inp)
{
//======================================================================
// Purpose: Create a named path
//======================================================================
  // Don't allow duplicate path names
  JobCPath* path(this->LookUpPath(name));
  if (path != 0) {
    MSG("JobC",Msg::kWarning) << 
      " Path '" << name << "' already exists!\n";
    return 0;
  }

  // Create the path and add it to the list ** Remember this module
  // owns the paths and has the responsibility to delete them! **
  path = new JobCPath(name,mom,inp);
  assert(path);
  fPathList.push_back(path);
#ifdef SITE_HAS_SIGC
  this->NewPath(path);
#endif
  return path;
}

//......................................................................

void JobCPathRegistry::DeletePath(const char* path)
{
//======================================================================
// Purpose: Remove a named path from the list of paths
//======================================================================
  // Find the path in the table
  vector<JobCPath*>::iterator itrPath(fPathList.begin());
  vector<JobCPath*>::iterator itrEnd(fPathList.end());
  for (; itrPath != itrEnd; ++itrPath) {
    if (strcmp(path,(*itrPath)->GetName())==0) {
      delete (*itrPath);        // Delete the path pointed to
      (*itrPath) = 0;           // Set the path pointer to zero
      fPathList.erase(itrPath); // Remove the element from the vector
    }
  }
}

//......................................................................

void JobCPathRegistry::Reset() 
{
//======================================================================
// Delete all active paths
//======================================================================
  std::vector<JobCPath*>::iterator itrPath(fPathList.begin());
  std::vector<JobCPath*>::iterator itrEnd(fPathList.end());
  for (; itrPath != itrEnd; ++itrPath) {
    delete (*itrPath); // Delete the path pointed to
    (*itrPath) = 0;    // Set the path pointer to zero
  }
  fPathList.erase(fPathList.begin(),itrEnd);
}

---