JobCResult.cxx

Go to the documentation of this file.

// $Id: JobCResult.cxx,v 1.4 2003/02/12 02:16:40 kasahara Exp $
//
// A class for encapsulating the result of running a job module on a
// given data record
//
// messier@huhepl.harvard.edu
#include "JobControl/JobCResult.h"
#include <iostream>

std::ostream& operator<<(std::ostream& os, const JobCResult& r)
{
  os << "[";
  if (r.ErrorLevel())       os << "E=" << r.ErrorLevel() << "/";
  if (r.Passed())           os << "P/";
  if (r.Failed())           os << "F/";
  if (r.BeginFile())        os << "BF/";
  if (r.EndFile())          os << "EF/";
  if (r.BeginRun())         os << "BR/";
  if (r.EndRun())           os << "ER/";
  if (r.BeginOfInputStream()) os << "BOF/";
  if (r.EndOfInputStream()) os << "EOF/";
  os << "]";
  return os;
}

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

JobCResult::JobCResult(JobCResult::Error_t result) : fResult(0)
{
//======================================================================
// Assign from an error flag
//======================================================================
  switch (result) {
  case JobCResult::kAOK:     fResult = kAOKFlg;     break;
  case JobCResult::kWarning: fResult = kWarningFlg; break;
  case JobCResult::kError:   fResult = kErrorFlg;   break;
  case JobCResult::kFatal:   fResult = kFatalFlg;   break;
  };
}
//......................................................................

JobCResult::JobCResult(JobCResult::Decision_t result) : fResult(0)
{
//======================================================================
// Assign from an pass/fail decision flag
//======================================================================
  switch (result) {
  case JobCResult::kPassed: fResult = kPassFlg; break;
  case JobCResult::kFailed: fResult = kFailFlg; break;
  };
}

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

JobCResult::JobCResult(JobCResult::IoFlag_t result) : fResult(0)
{
//======================================================================
// Assign from an I/O status flag
//======================================================================
  switch (result) {
  case JobCResult::kBeginFile:        fResult= kBeginFileFlg;        break; 
  case JobCResult::kEndFile:          fResult= kEndFileFlg;          break;
  case JobCResult::kBeginRun:         fResult= kBeginRunFlg;         break;
  case JobCResult::kEndRun:           fResult= kEndRunFlg;           break;
  case JobCResult::kBeginOfInputStream: fResult= kBeginOfInputStreamFlg; break;
  case JobCResult::kEndOfInputStream: fResult= kEndOfInputStreamFlg; break;
  case JobCResult::kNonPhysicsRecord: fResult= kNonPhysicsRecordFlg; break;
  };
}

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

JobCResult& JobCResult::operator=(Error_t result) 
{
//======================================================================
// Set any error flags. With the exception of AOK these are cumulative
//======================================================================
  switch (result) {
  case JobCResult::kAOK:     fResult &= (~kErrorMask); break;
  case JobCResult::kWarning: this->SetWarning();       break;
  case JobCResult::kError:   this->SetError();         break;
  case JobCResult::kFatal:   this->SetFatal();         break;
  };
  return *this;
}

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

JobCResult& JobCResult::operator=(Decision_t result) 
{
//======================================================================
// Set the pass/fail result
//======================================================================
  switch (result) {
  case JobCResult::kPassed: this->SetPassed(); break;
  case JobCResult::kFailed: this->SetFailed(); break;
  };
  return *this;
}

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

JobCResult& JobCResult::operator=(IoFlag_t result) 
{
//======================================================================
// Set any I/O flags. These are all cumulative
//======================================================================
  switch (result) {
  case kBeginFile:        this->SetBeginFile(); break;
  case kEndFile:          this->SetEndFile();   break;
  case kBeginRun:         this->SetBeginRun();  break;
  case kEndRun:           this->SetEndRun();    break;
  case kBeginOfInputStream: this->SetBeginOfInputStream();  break;
  case kEndOfInputStream: this->SetEndOfInputStream();  break;
  case kNonPhysicsRecord: this->SetNonPhysicsRecord();    break;
  };
  return *this;
}

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

JobCResult& JobCResult::operator|=(const JobCResult& rhs)
{
//======================================================================
// Combine some results
//======================================================================
  fResult |= rhs.fResult;
  return *this;
}

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

bool JobCResult::HaveError() const 
{
//======================================================================
// Are any error bits set?
//======================================================================
  return (fResult & kErrorMask) != 0;
}

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

bool JobCResult::HaveDecision() const 
{
//======================================================================
// Are any pass/fail decision bits set?
//======================================================================
  return (fResult & kDecisionMask) != 0;
}

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

bool JobCResult::HaveIoFlag() const 
{
//======================================================================
// Are any I/O flags set?
//======================================================================
  return (fResult & kIoMask) != 0;
}

//......................................................................
  
JobCResult::Error_t JobCResult::ErrorLevel() const 
{
//======================================================================
// What's the severity of the error condition?
//======================================================================
  Error_t e = kAOK;
  if (fResult & kWarningFlg) e = JobCResult::kWarning;
  if (fResult & kErrorFlg)   e = JobCResult::kError;
  if (fResult & kFatalFlg)   e = JobCResult::kFatal;
  return e;
}

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

//======================================================================
// Return pass/fail decision
//======================================================================
bool JobCResult::Passed() const { return fResult&JobCResult::kPassFlg; }
bool JobCResult::Failed() const { return fResult&JobCResult::kFailFlg; }

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

bool JobCResult::BeginFile() const
{
//======================================================================
// Have we started a new file?
//======================================================================
  return (fResult & kBeginFileFlg)!=0;
}

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

bool JobCResult::EndFile() const
{
//======================================================================
// Have we finished with a file?
//======================================================================
  return (fResult & kEndFileFlg)!=0; 
}

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

bool JobCResult::BeginRun() const 
{ 
//======================================================================
// Have we started a new run?
//======================================================================
  return (fResult & kBeginRunFlg)!=0; 
}

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

bool JobCResult::EndRun() const 
{
//======================================================================
// Have we ended a run?
//======================================================================
  return (fResult & kEndRunFlg)!=0; 
}

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

bool JobCResult::BeginOfInputStream() const 
{ 
//======================================================================
// Beginning of input streams?
//======================================================================
  return (fResult & kBeginOfInputStreamFlg)!=0; 
}

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

bool JobCResult::EndOfInputStream() const 
{ 
//======================================================================
// Has the input stream run dry?
//======================================================================
  return (fResult & kEndOfInputStreamFlg)!=0; 
}

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

bool JobCResult::NonPhysicsRecord() const 
{ 
//======================================================================
// Has the input stream delivered something besides physics events?
//======================================================================
  return (fResult & kNonPhysicsRecordFlg)!=0; 
}

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

//======================================================================
// Setters for the error condition flags
//======================================================================
JobCResult& JobCResult::SetAOK() {
  fResult &= (~kErrorMask); // Lower all error flags
  return *this;
}
JobCResult& JobCResult::SetWarning() {
  fResult |= kWarningFlg;   
  return *this;
}
JobCResult& JobCResult::SetError() {
  fResult |= kErrorFlg;     
  return *this;
}
JobCResult& JobCResult::SetFatal() {
  fResult |= kFatalFlg;
  return *this;
}

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

//======================================================================
// Setters for the pass/fail decision flags
//======================================================================
JobCResult& JobCResult::SetFailed() {
  this->ClearPassFail();
  fResult |= kFailFlg;
  return *this;
}
JobCResult& JobCResult::SetPassed() {
  this->ClearPassFail();
  fResult |= kPassFlg;
  return *this;
}
JobCResult& JobCResult::ClearPassFail() {
  fResult &= (~kDecisionMask); 
  return *this;
}

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

//======================================================================
// Setters for the I/O flags
//======================================================================
JobCResult& JobCResult::SetBeginFile() { 
  fResult |= kBeginFileFlg;
  return *this;
}
JobCResult& JobCResult::SetEndFile() {
  fResult |= kEndFileFlg;
  return *this;
}
JobCResult& JobCResult::SetBeginRun() {
  fResult |= kBeginRunFlg;
  return *this;
}
JobCResult& JobCResult::SetEndRun(){ 
  fResult |= kEndRunFlg;
  return *this;
}
JobCResult& JobCResult::SetBeginOfInputStream() { 
  fResult |= kBeginOfInputStreamFlg; 
  return *this;
}
JobCResult& JobCResult::SetEndOfInputStream() { 
  fResult |= kEndOfInputStreamFlg; 
  return *this;
}
JobCResult& JobCResult::SetNonPhysicsRecord() {
  fResult |= kNonPhysicsRecordFlg;
  return *this;
}

---