JobCResult.h

Go to the documentation of this file.

// $Id: JobCResult.h,v 1.3 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
#ifndef JOBCRESULT_H
#define JOBCRESULT_H
#ifndef IOSFWD
#include <iosfwd>
#define IOSFWD
#endif

class JobCResult
{
  friend std::ostream& operator<<(std::ostream& os, const JobCResult& r);
public:
  //====================================================================
  // Define the set of possible results of running a job module
  
  // Use these flags if something has gone wrong while processing the event
  typedef enum EErrorFlag {
    kAOK     =0, // No problem -- everything is fine
    kWarning =1, // Something might be wrong. Keep running (by default).
    kError   =2, // Hey! That's not supposed to happen. Stop run.
    kFatal   =3  // My world is upside down!. Dump core.
  } Error_t;

  // Use these flags to communicate pass/fail decisions made on the event
  typedef enum EDecisionFlag {
    kPassed,  // Record passes selection cuts
    kFailed   // Record fails selection cuts
  } Decision_t;

  // Use these when the I/O status changes
  typedef enum EIoFlag {
    kBeginFile,        // Start of new file
    kEndFile,          // End of file
    kBeginRun,         // Start of new run
    kEndRun,           // End of run
    kBeginOfInputStream, // Begin of input streams
    kEndOfInputStream,   // End of input streams
    kNonPhysicsRecord  // The record represents non-physics data
  } IoFlag_t;
  //====================================================================

public:
  JobCResult(JobCResult::Error_t    result=kAOK);
  JobCResult(JobCResult::Decision_t result);
  JobCResult(JobCResult::IoFlag_t   result);
  
  JobCResult& operator=(JobCResult::Error_t    result);
  JobCResult& operator=(JobCResult::Decision_t result);
  JobCResult& operator=(JobCResult::IoFlag_t   result);
  JobCResult& operator|=(const JobCResult& rhs);

  // Are flags set?
  bool HaveError()    const;
  bool HaveDecision() const;
  bool HaveIoFlag()   const;
  
  // Which flags are set?
  JobCResult::Error_t ErrorLevel()       const;
  bool                Passed()           const;
  bool                Failed()           const;
  bool                BeginFile()        const;
  bool                EndFile()          const;
  bool                BeginRun()         const;
  bool                EndRun()           const;
  bool                BeginOfInputStream() const;
  bool                EndOfInputStream() const;
  bool                NonPhysicsRecord() const;
  
  // Set flags in the result
  JobCResult& SetAOK();
  JobCResult& SetWarning();
  JobCResult& SetError();
  JobCResult& SetFatal();
  JobCResult& SetFailed();
  JobCResult& SetPassed();
  JobCResult& ClearPassFail();
  JobCResult& SetBeginFile();
  JobCResult& SetEndFile();
  JobCResult& SetBeginRun();
  JobCResult& SetEndRun();
  JobCResult& SetBeginOfInputStream();
  JobCResult& SetEndOfInputStream();
  JobCResult& SetNonPhysicsRecord();
  
private:
  // Define the bit fields for the different flags
  static const int kErrorMask           = 0x000F;
  static const int kAOKFlg              = 0x0000;
  static const int kWarningFlg          = 0x0001;
  static const int kErrorFlg            = 0x0002;
  static const int kFatalFlg            = 0x0004;
  
  static const int kDecisionMask        = 0x00F0;
  static const int kPassFlg             = 0x0010;
  static const int kFailFlg             = 0x0020;
  
  static const int kIoMask              = 0xFF00;
  static const int kBeginFileFlg        = 0x0100;
  static const int kEndFileFlg          = 0x0200;
  static const int kBeginRunFlg         = 0x0400;
  static const int kEndRunFlg           = 0x0800;
  static const int kEndOfInputStreamFlg = 0x1000;
  static const int kNonPhysicsRecordFlg = 0x2000;
  static const int kBeginOfInputStreamFlg = 0x4000;
  
  int fResult; // The result of processing a data record
};

#endif // JOBCRESULT_H

---