JobCModule.cxx

Go to the documentation of this file.

// $Id: JobCModule.cxx,v 1.32 2006/04/07 18:29:53 boehm Exp $
//
// An empty job module. 
//
// messier@huhepl.harvard.edu
#include <MessageService/MsgService.h>

#include "JobCModule.h"
#include "JobCommand.h"
#include "JobCResult.h"
#include "JobCInputModule.h"
#include "JobCPath.h"

CVSID("$Id: JobCModule.cxx,v 1.32 2006/04/07 18:29:53 boehm Exp $");

// Warning message for un-implemented functions
static const char *gsMessage = "Module does not implement: ";

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

JobCModule::JobCModule() : fName(""), fConfig(false), fPath(0) { }

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

void JobCModule::Init(const char* name) 
{
  fName = name;
  
  // Configure the module with the defaults
  // "=" doesn't affect the name of the registry...
  Registry r = this->DefaultConfig();
  this->GetConfig().UnLockValues();
  this->GetConfig() = r;
  this->GetConfig().SetName(r.GetName());
  this->Config(this->GetConfig());

  this->GetConfig().LockKeys();
}

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

JobCModule::~JobCModule() {}

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

const char *JobCModule::GetName() const { return fName.c_str(); }

const char* JobCModule::GetUniqueName() const 
{
    const char* name=0;
    if (!fConfig.Get("UniqueName",name)) return 0;
    return name;
}

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

void JobCModule::BeginJob() {
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::BeginJob for module " << this->GetName() << "\n";
}

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

void JobCModule::EndJob() {
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::End for module " << this->GetName() << "\n";
}

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

void JobCModule::BeginFile() {
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::BeginFile for module " << this->GetName() << "\n";
}

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

void JobCModule::EndFile() {
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::EndFile for module " << this->GetName() << "\n";
}

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

void JobCModule::BeginRun() 
{
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::BeginRun for module " << this->GetName() << "\n";
}

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

void JobCModule::EndRun() 
{
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::EndRun for module " << this->GetName() << "\n";
}

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

JobCInputModule* JobCModule::GetJobCInputModule() const
{
  if (!fPath) {
    MSG("JobC",Msg::kWarning)
      << fName << " has no associated JobCPath" << endl;
    return 0;
  }     
  JobCInputModule* m = fPath->GetInputModule();
  if (!m) {
    MSG("JobC",Msg::kWarning)
      << "the associated path for " << fName
      << " has no input module" << endl;
    return 0;
  }
  return m;
}

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

Int_t JobCModule::GetCurrentRun() const
{
    JobCInputModule* m = GetJobCInputModule();
    if (!m) return -1;
    return m->GetCurrentRun();
}

Int_t JobCModule::GetLastRun() const
{
    JobCInputModule* m = GetJobCInputModule();
    if (!m) return -1;
    return m->GetLastRun();
}

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

const char* JobCModule::GetCurrentFile(const char* streamname) const
{
    JobCInputModule* m = GetJobCInputModule();
    if (!m) return "";
    return m->GetCurrentFile(streamname);
}

const char* JobCModule::GetLastFile(const char* streamname) const
{
    JobCInputModule* m = GetJobCInputModule();
    if (!m) return "";
    return m->GetLastFile(streamname);
}

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

const Registry& JobCModule::DefaultConfig() const
{
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::DefaultConfig for module " << this->GetName() << "\n";

  static const Registry r; // Empty...
  return r;
}

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

void JobCModule::Config(const Registry& r) 
{
  MSG("JobC",Msg::kDebug) << 
    "JobCModule::Config for module " << this->GetName() << "\n";
  
  // The default config command just does a copy...
  bool islocked = this->GetConfig().ValuesLocked();
  if (islocked) this->GetConfig().UnLockValues();
  this->GetConfig() = r;
  if (islocked) this->GetConfig().LockValues();  
}


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

JobCResult JobCModule::Get(MomNavigator * /* mom */) 
{
//======================================================================
// Purpose: Dummy Get method
//======================================================================
  MSG("JobC", Msg::kError) << gsMessage << "'Get'\n";
  return JobCResult::kError;
}

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

JobCResult JobCModule::Put(const MomNavigator * /* mom */)
{
//======================================================================
// Purpose: Dummy Put method
//======================================================================
  MSG("JobC", Msg::kError) << gsMessage << "'Put'\n";
  return JobCResult::kError;
}

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

JobCResult JobCModule::Ana(const MomNavigator * /* mom */) 
{
//======================================================================
// Purpose: Dummy Ana method
//======================================================================
  MSG("JobC", Msg::kError) << gsMessage << "'Ana'\n";
  return JobCResult::kError;
}

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

JobCResult JobCModule::Reco(MomNavigator * /* mom */) 
{
//======================================================================
// Purpose: Dummy Reco method
//======================================================================
  MSG("JobC", Msg::kError) << gsMessage << "'Reco'\n";
  return JobCResult::kError;
}

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

void JobCModule::Cmd(const char* cmd) 
{
//======================================================================
// Pass commands through like this for now...
//======================================================================
  JobCommand c(cmd);
  this->HandleCommand(&c);
}

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

void JobCModule::HandleCommand(JobCommand *command) 
{
//======================================================================
// Warn users that this module does not implement HandleCommand
//======================================================================
  if (command) {
    MSG("JobC", Msg::kWarning) 
      << gsMessage << "'HandleCommand': " << command->PopCmd() << endl;
  }
  else {
    MSG("JobC", Msg::kWarning) << gsMessage << "'HandleCommand':\n";
  }
}

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

void JobCModule::Help() 
{
//======================================================================
// Warn users that this module does not implement Help
//======================================================================
  MSG("JobC", Msg::kWarning) << 
    "No help available for module '" << this->GetName() << "'\n";
}

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

void JobCModule::Report() 
{
//======================================================================
// The default report command prints the module configuration
//======================================================================
  MsgStream& m = MSGSTREAM("JobCReport",Msg::kInfo);
  m << this->GetName() << " configured with: " << std::endl;
  this->GetConfig().PrettyPrint(std::cout);
}

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

void JobCModule::Reset() 
{
  // Reset restores the module to its original configuration
  this->Config(this->DefaultConfig());
}

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

void JobCModule::Set(const char* s) 
{ 
//======================================================================
// The "Set" command takes a string of the format:
//
// Set("a=1 b=2.0 c=4.0e9 d=astring.option e='another string option'");
//======================================================================
  // Build a command like "Set a=1 b=2";
  Registry r;
  JobCommand::StringToRegistry(r,s);

  // Reset the values in the module's config.
  this->GetConfig().UnLockValues();
  this->GetConfig().Merge(r);
  this->GetConfig().LockValues();

  // Pass the reconfigure signal off to the module
  this->Config(this->GetConfig()); // Pass the whole config 
                                   // safest but wasteful

  // this->Config(r);    // Pass just the updated values.
}

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

void JobCModule::Set(JobCDialog* d)
{
//======================================================================
// Change the module's configuration using a dialog object
//======================================================================
  bool deleted = false; // Delete dialog it before return?
  if (d == 0) {
    d = new JobCDialog();
    deleted = true;
  }
  
  // Set up d with the module's configuration parameters
  d->SetDefault(this->DefaultConfig());
  d->SetCurrent(this->GetConfig());

  // Do the querry...
  Registry r = d->Querry();
  
  // Set the module config
  this->GetConfig().UnLockValues();
  this->GetConfig().Merge(r);
  this->GetConfig().LockValues();

  this->Config(this->GetConfig());
  
  // Clean up
  if (deleted) { delete d; d=0; }
}

//......................................................................
bool JobCModule::SetUniqueName(const char* name)
{
    if (fConfig.KeyExists("UniqueName")) return false;
    bool locked = fConfig.KeysLocked();
    fConfig.UnLockKeys();
    fConfig.Set("UniqueName",name);
    if (locked) fConfig.LockKeys();
    return true;
}

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

Registry& JobCModule::GetConfig() 
{ 
//======================================================================
// This is a faily subtle point. Module's may wish to overwrite which
// Registry holds their configuration. Support that with this virtual
// function. Notice that the code above never nevers to fConfig but
// always to this->GetConfig(). For an example of a mode that makes
// use of this see JobCInput module.
//======================================================================
  return fConfig; 
}

---