RecJobHistory.cxx

Go to the documentation of this file.

//
// RecJobHistory
//
// RecJobHistory holds information about the jobs used to create or fill
// a record.
//
// Author:  S. Kasahara   10/07
//
#include <cassert>
#include <iostream>
using namespace std;

#include "MessageService/MsgService.h"
#include "Record/RecJobRecord.h"
#include "Record/RecJobHistory.h"

ClassImp(RecJobHistory)

CVSID("$Id: RecJobHistory.cxx,v 1.6 2009/04/12 00:20:12 schubert Exp $");


const UInt_t RecJobHistory::kNJobType = 10; // number of valid job types

// Definition of methods
// *********************

//_____________________________________________________________________________
RecJobHistory::RecJobHistory() {
  // Default constructor

  MSG("Rec",Msg::kDebug) << "RecJobHistory default ctor @ " << this << endl;
  
}

//_____________________________________________________________________________
RecJobHistory::RecJobHistory(const RecJobHistory& that) : TObject(that) {
  // Copy constructor

  MSG("Rec",Msg::kDebug) << "RecJobHistory copy ctor @ " << this << endl;
  Append(that);
  
}
  
//_____________________________________________________________________________
RecJobHistory::~RecJobHistory() {
  // Destructor
  
  MSG("Rec",Msg::kDebug) << "RecJobHistory dtor @ " << this << endl;

  JobRecordMapItr itr; 
  for ( itr = fJobRecordMap.begin(); itr != fJobRecordMap.end(); itr++ ) {
    RecJobRecord* jobrecord = itr->second;
    delete jobrecord;
  }
  fJobRecordMap.clear();
  
}

//_____________________________________________________________________________
const char* RecJobHistory::JobTypeAsString(JobType_t jobtype) const {
  // Purpose: Convert enumerated jobtype to a string.

  switch (jobtype) {

  case kRaw:
    return "Raw";
  case kGMinos:
    return "GMinos";
  case kPTSim:
    return "PTSim";
  case kPhotonTransport:
    return "PhotonTransport";
  case kCand:
    return "Cand";
  case kNtpMC:
    return "NtpMC";
  case kNtpTH:
    return "NtpTH";
  case kNtpSR:
    return "NtpSR";
  case kNtpSt:
    return "NtpSt";
  case kUnknownJobType:
    return "UnknownJobType";
  default:
    MSG("Rec",Msg::kWarning)
      << "RecJobHistory::JobTypeAsString called with unknown JobType_t "
      << (int)jobtype << ". Fix method. Abort." << endl;
    abort();
  } // end of switch

}

//_____________________________________________________________________________
const RecJobRecord* RecJobHistory::GetJobRecord(JobType_t jobtype) const {
  // Get ptr to job record by enumerated job type.
  // Return null if not found.

  std::string jobtypestr = JobTypeAsString(jobtype);
  if ( jobtypestr == "UnknownJobType" ) return 0;

  return GetJobRecord(jobtypestr.c_str());
}

//_____________________________________________________________________________
const RecJobRecord* RecJobHistory::GetJobRecord(const char* jobtypestr) const {
  // Get job record by character string job type.
  // Return null if not found.

  JobRecordMapConstItr citr = fJobRecordMap.find(jobtypestr);
  if ( citr != fJobRecordMap.end() ) return citr->second;
  else return 0;
  
}

//_____________________________________________________________________________
std::ostream& RecJobHistory::Print(std::ostream& os) const {
  //  Purpose:  Print history on ostream.  Job records are printed in
  //            sequential order by timestamp.

  std::map<const RecJobRecord*,std::string,compareJobRecord> recmapbytime;
  JobRecordMapConstItr citr;
  for ( citr = fJobRecordMap.begin(); citr != fJobRecordMap.end(); citr++ ) {
    recmapbytime.insert(make_pair(citr->second,citr->first));
  }
  
  os << "RecJobHistory:";
  if ( recmapbytime.empty() ) os << " <<empty>>" << endl;
  else  os << endl;

  std::map<const RecJobRecord*,std::string,compareJobRecord>::const_iterator 
                                                                       tcitr; 
  for ( tcitr = recmapbytime.begin(); tcitr != recmapbytime.end(); tcitr++ ) {
    os << tcitr->second << "\t" << *(tcitr->first) << endl;
  }

  return os;

}

//_____________________________________________________________________________
void  RecJobHistory::Print(Option_t* /* option */) const {
  //  Purpose:  Print header in form supported by TObject::Print.

  Print(std::cout);

  return;

}

//_____________________________________________________________________________
bool RecJobHistory::Append(const RecJobHistory& that) {
  // Append the contents of that's history to this.
  
  JobRecordMapConstItr citr; 
  const JobRecordMap& thatJobRecordMap = that.GetJobRecordMap();
  bool allpass = true;
  for ( citr = thatJobRecordMap.begin(); citr != thatJobRecordMap.end(); 
                                                                citr++ ) {
    allpass &= CreateJobRecord((citr->first).c_str(),*(citr->second));
  }

  return allpass;

}

//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(JobType_t jobtype) {
  // Create job record from current job environment and insert it in the 
  // fJobRecordMap with the associated jobtype string as key.  
  // Return true if successful, or false if jobtype is unknown.

  return CreateJobRecord(JobTypeAsString(jobtype));

}

//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(const char* jobtypestr) {
  // Create job record from current job environment and insert it in 
  // the fJobRecordMap with the specified jobtypestr as key.  Return true
  // if successful, or false if jobtypestr is "UnknownJobType".

  RecJobRecord* jobrec = new RecJobRecord();
  bool isOk = AdoptJobRecord(jobtypestr,jobrec);
  if ( !isOk ) delete jobrec;
  return isOk;
  
}

//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(JobType_t jobtype, const char* prodname, 
                                    const char* codename,const char* hostname,
                                    const VldTimeStamp& timestamp) {
  // Create job record from arguments and insert it in the 
  // fJobRecordMap with the associated jobtype string as key.  
  // Return true if successful, or false if jobtype is unknown.

  return CreateJobRecord(JobTypeAsString(jobtype),prodname,codename,
                         hostname,timestamp);
  
}

//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(const char* jobtypestr,
                                    const char* prodname, const char* codename,
                                    const char* hostname,
                                    const VldTimeStamp& timestamp) {
  // Create job record from arguments and insert it in 
  // the fJobRecordMap with the specified jobtypestr as key.  Return true
  // if successful or false if jobtypestr is "UnknownJobType".

  RecJobRecord* jobrec = new RecJobRecord(prodname,codename,hostname,
                                          timestamp);
  bool isOk = AdoptJobRecord(jobtypestr,jobrec);
  if ( !isOk ) delete jobrec;
  return isOk;
  
}
  
//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(JobType_t jobtype,
                                    const RecJobRecord& jobrec_tocopy) {
  // Create job record as copy from the input jobrec_tocopy and insert it 
  // in the fJobRecordMap with the associated jobtype string as key.  
  // Return true if successful, or false if jobtype is unknown.

  return CreateJobRecord(JobTypeAsString(jobtype),jobrec_tocopy);

}

//_____________________________________________________________________________
bool RecJobHistory::CreateJobRecord(const char* jobtypestr,
                                    const RecJobRecord& jobrec_tocopy) {
  // Create job record from the input jobrec_tocopy and insert it in 
  // the fJobRecordMap with the specified jobtypestr as key.  Return true
  // if successful, or false if jobtypestr is "UnknownJobType".

  RecJobRecord* jobrec = new RecJobRecord(jobrec_tocopy);
  bool isOk = AdoptJobRecord(jobtypestr,jobrec);
  if ( !isOk ) delete jobrec;
  return isOk;
  
}

//_____________________________________________________________________________
bool RecJobHistory::AdoptJobRecord(const char* jobtypestr,
                                   RecJobRecord* jobrec) {
  // Insert job ptr to map with the specified jobtypestr as key.
  // If entry already exists, user will be warned and then entry
  // will be overrriden with new record.
  // Return true if success.  Return false if jobtypestr is "UnknownJobType"
  // and no insertion will be made in this case.

  if ( std::string(jobtypestr) == "UnknownJobType" ) {
    MSG("Rec",Msg::kWarning) << "RecJobHistory::CreateJobRecord "
                             << "received Unknown jobtypestr " << jobtypestr 
                             << ". Ignored." << endl;
    return false;
  }

  JobRecordMapItr itr = fJobRecordMap.find(jobtypestr);
  
  if ( itr != fJobRecordMap.end() ) {
    // Found record map entry of same job type.  Check to see if
    // it is an equivalent record, otherwise Print warning.
    if ( *(itr->second) != *jobrec ) {
      MSG("Rec",Msg::kWarning) << "RecJobHistory::CreateJobRecord "
                               << "Found existing entry of requested type "
                               << jobtypestr << ". Replaced." 
                               << endl;
    }
    delete (itr->second); // delete old record
    itr->second = jobrec; // insert new
  }
  else {
    fJobRecordMap.insert(make_pair(jobtypestr,jobrec));
  }
  
  return true;
  
}

//_____________________________________________________________________________
ReleaseType::Release_t RecJobHistory::GetProdReleaseType(
                                                  UInt_t jobtypemask) const {
  // Get OR of production release types associated with job records selected
  // as specified in the input jobtypemask.  jobtypemask corresponds
  // to a bit mask of OR'ed EJobTypes. 
  // The default is to return the OR of production release types corresponding 
  // to records of type kCand or kGMinos.
  // Specifying jobtypemask = EJobType::kUnknownJobType requests the OR of all 
  // record release types in the job history.
  // Returns ReleaseType::kUnknown if unknown. 

  ReleaseType::Release_t release = ReleaseType::kUnknown;
  
  if ( kUnknownJobType == jobtypemask ) {
    // Loop over all records in the history and construct OR of release types
    JobRecordMapConstItr citr;
    for ( citr = fJobRecordMap.begin(); citr != fJobRecordMap.end(); citr++ ) {
      ReleaseType::Release_t recrelease = citr->second->GetProdReleaseType();
      if ( recrelease != ReleaseType::kUnknown ) {
        if ( release != ReleaseType::kUnknown ) release |= recrelease;
        else release = recrelease;
      }
    }
    return release;
  }
  
  // Otherwise, seek records of jobtype matching those specified in jobtypemask
  for ( UInt_t it = 0; it < kNJobType-1; it++ ) {
    UInt_t jobbit = 1 << it;
    if ( jobbit & jobtypemask ) {
      EJobType jobtype = static_cast<EJobType>(jobbit);
      const RecJobRecord* jobrecord = GetJobRecord(jobtype);
      if ( jobrecord ) {
        ReleaseType::Release_t recrelease = jobrecord->GetProdReleaseType();
        if ( recrelease != ReleaseType::kUnknown ) {
          if ( release != ReleaseType::kUnknown ) release |= recrelease;
          else release = recrelease;
        }
      }
    }
  }

  return release;
  
}

---