JobCNode.cxx

Go to the documentation of this file.

// $Id: JobCNode.cxx,v 1.33 2002/05/14 23:29:03 rhatcher Exp $
//
// A module::method pair
//
// messier@huhepl.harvard.edu
#include "JobControl/JobCNode.h"
#include <cstring> // strcmp()
#include <iomanip>
extern "C" {
#include <unistd.h>    // sysconf
#include <sys/times.h> // times()
}
#include "MessageService/MsgService.h"
#include "MessageService/MsgFormat.h"
#include "JobControl/JobCResult.h"
#include "JobControl/JobCModule.h"
#include "JobControl/JobCMethod.h"

CVSID("$Id: JobCNode.cxx,v 1.33 2002/05/14 23:29:03 rhatcher Exp $");

ClassImp(JobCNode)

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

ostream& operator<<(ostream& os, const JobCNode& n)
{
  // Convert time to seconds 
  static double ticksPerSecond = sysconf(_SC_CLK_TCK); // units used by times()
  double ut = (float)n.fUserTime/ticksPerSecond;
  double st = (float)n.fSystemTime/ticksPerSecond;
  
  MsgFormat ifmt1("%-6d");
  MsgFormat ifmt2("%6d");
  MsgFormat dfmt("%8.2f");

  string modmeth = n.fModule->GetName();
  modmeth += "::";
  modmeth += n.fMethod->GetName();
  
  if (n.fFilterActive) {
    if (n.fFilterReverse) {
      os << "!";
    }
    else {
      os << "+";
    }
  }
  else {
    os << " ";
  }
  os.setf(ios::left); // Set format to left justified
  os.fill(' ');
  os << setw(25);
  os << modmeth.c_str();
  
  os << " n=" 
     << ifmt1(n.fNin) 
     << "("
     << ifmt2(n.fNpass) 
     << "/" 
     << ifmt2(n.fNfail) 
     << ")"
     << " t=(" 
     << dfmt(ut) 
     << "/" 
     << dfmt(st) 
     << ")";
  return os;
}

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

void JobCNode::Init() 
{
//======================================================================
// Purpose: Initialize this node
//======================================================================
  fModule = 0;
  fMethod = 0;
  fFilterActive  = true;
  fFilterReverse = false;
  fNin   = 0;
  fNpass = 0;
  fNfail = 0;
  fUserTime   = 0l;
  fSystemTime = 0l;
}

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

JobCNode::JobCNode() 
{
//======================================================================
// Purpose: Create an empty node
//======================================================================
  this->Init();
}

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

JobCNode::JobCNode(JobCModule* module, const JobCMethod* method)
{
//======================================================================
// Purpose: Create a node give a module and a method pair
//
// Inputs: module - the module to use
//         method - the module's method to use
//======================================================================
  this->Init();

  // Set the module and method for this node
  fModule = module;
  fMethod = method;
  
  // Make sure the module implementes this method
  if (fMethod->Exists(fModule) == false) {
    MSG("JobC", Msg::kWarning) 
      << "Module does not implement this method\n";
    fModule = 0;
    fMethod = 0;
    return;
  }
}

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

JobCNode::~JobCNode() {}

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

JobCResult JobCNode::Execute(MomNavigator *mom)
{
//======================================================================
// Purpose: Give this node a look at a data records
//
// Inputs: mom - the MINOS Object Map that holds the data to process
//
// Returns: Pass/Fail/No Decision depending on how the data record
//          is evaluted by the module::method
//======================================================================
  clock_t dummyt;    // Unused return variable
  struct tms t1;     // Times before execution of node
  struct tms t2;     // Times after execution of node
  JobCResult result; // Result of node

  // Evaluate the data record -- keep track of the time it takes...
  dummyt = times(&t1);
  result = fMethod->Execute(fModule, mom);
  dummyt = times(&t2);

  fUserTime   += (t2.tms_utime-t1.tms_utime);
  fSystemTime += (t2.tms_stime-t1.tms_stime);

  // If we've reached the end of input, return before accumulating
  // statistics
  if (result.EndOfInputStream()) return result;

  // Count records seen
  ++fNin;

  // Count records passed and failed at each node
  if (result.Failed()) {
    ++fNfail;
  } 
  else {
    // "No-decisions" and "Passed" count as pass
    ++fNpass;
  }
  
  // Determine return type
  if (fFilterActive) {
    if (fFilterReverse) {
      // Reverse the meaning of pass/fail
      if      (result.Passed()) result.SetFailed(); 
      else if (result.Failed()) result.SetPassed();
    }
  }
  else {
    // The filter is not active -- clear any pass/fail decisions
    result.ClearPassFail();
  }

  return result;
}

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

bool JobCNode::MatchModuleMethod(const char* mod, const char* meth) 
{
//======================================================================
// Purpose: Check if this node matches a module::method pair
//
// Inputs: mod  - name of the module
//         meth - name of the method
//
// Returns: true/false depending on if this node is a perfect match
//======================================================================
  if (strcmp(mod ,fModule->GetName())==0 && 
      strcmp(meth,fMethod->GetName())==0) {
    return true;
  }
  return false;
}

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

JobCModule* JobCNode::GetModule() const { return fModule; }

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

JobCMethod JobCNode::GetMethod() const
{
//======================================================================
// Purpose: Return the method this node uses
//======================================================================
  return (*fMethod);
}

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

void JobCNode::SetModule(JobCModule *module)
{
//======================================================================
// Purpose: Set the module this node should use
//
// Inputs: module - pointer to the job module to use at this node
//======================================================================
  fModule = module;
  if (fModule == 0) {
    MSG("JobC", Msg::kError) 
      << "Attempt to set NULL module.\n";
  }
}

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

void JobCNode::SetMethod(JobCMethod *method)
{
//======================================================================
// Purpose: Set the method this node should call
//
// Inputs: method - pointer to the method to use at this node
//======================================================================
  fMethod = method;
  if (fMethod == 0) {
    MSG("JobC", Msg::kError) 
      << "Attempt to set NULL method.\n";
  }
}

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

void JobCNode::FilterOn()  
{
//======================================================================
// Purpose: Activate filtering on this node
//======================================================================
  fFilterActive = true;
#ifdef SITE_HAS_SIGC
  this->SigUpdate(this,JobCNode::kFilter);
#endif
}

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

void JobCNode::FilterOff() 
{
//======================================================================
// Purpose: Deactivate filtering on this node
//======================================================================
  fFilterActive = false;
#ifdef SITE_HAS_SIGC
  this->SigUpdate(this,JobCNode::kFilter);
#endif
}

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

void JobCNode::ReverseFilter() 
{
//======================================================================
// Purpose: Reverse the meaning of pass/fail for this node
//======================================================================
  fFilterActive  = true;
  fFilterReverse = !fFilterReverse;
#ifdef SITE_HAS_SIGC
  this->SigUpdate(this,JobCNode::kFilter);
#endif
}

---