RecMinos.cxx

Go to the documentation of this file.

//
// RecMinos
//
// RecMinos is the Base Class for MINOS records
//
// Author:  R. Hatcher   4/2001
//

#include <iostream>
using std::cout;
using std::endl;

#include "Record/RecMinos.h"
#include "Record/RecMinosHdr.h"

ClassImp(RecMinos)

//_____________________________________________________________________________
RecMinos::RecMinos()
   : fHeader(new RecMinosHdr())
{
   // Default constructor
   fComponents.SetOwner(true);
   fTemporaries.SetOwner(true);
}

//_____________________________________________________________________________
RecMinos::RecMinos(RecMinosHdr* header)
   : fHeader(header)
{
   // normal ctor, adopts the RecMinosHdr for ownership
   fComponents.SetOwner(true);
   fTemporaries.SetOwner(true);
}


//_____________________________________________________________________________
RecMinos::~RecMinos()
{
  // delete all owned sub-objects 
  fComponents.Delete(); 
  fTemporaries.Delete(); 

  if (fHeader) delete fHeader; fHeader = 0;

}

//_____________________________________________________________________________
void RecMinos::AdoptComponent(TObject* component) 
{
  fComponents.Add(component);
}
//_____________________________________________________________________________
void RecMinos::AdoptTemporary(TObject* temporary) 
{
  fTemporaries.Add(temporary);
}

//_____________________________________________________________________________
TObject* RecMinos::RemoveComponent(TObject* component) 
{
  return fComponents.Remove(component);
}
//_____________________________________________________________________________
TObject* RecMinos::RemoveTemporary(TObject* temporary) 
{
  return fTemporaries.Remove(temporary);
}

//_____________________________________________________________________________
const TObject* RecMinos::FindComponent(const char *classname,
                                       const char *objname) const
{

// Returns the *last* selected Component.  If classname is a null ptr
// or blank string, no class selection is done.  If classname is
// provided, the qualifying object must InheritFrom() or be a classname.
// The objname is optional, but, if filled, will further qualify the
// selection by requiring agreement with the GetName() method of the
// selected object.

   TString classtr("");
   if (classname)
      classtr.Append(TString(classname).Strip(TString::kBoth));

   TString objstr("");
   if (objname)
     objstr.Append(TString(objname).Strip(TString::kBoth));

   TObjArrayIter itr(&fComponents,kIterBackward);
   TObject *obj;

   while ((obj = itr())) {

// First check whether object InheritsFrom "classname"
     if (classtr.IsNull() || obj->InheritsFrom(classtr)) {

// Then check whether object name equals "objname"
       if (objstr.IsNull() || (objstr == obj->GetName()))
         return obj;
     }
   }
   return 0;

}

//_____________________________________________________________________________
const TObject* RecMinos::FindTemporary(const char *classname,
                                       const char *objname) const
{

// Returns the *last* selected Temporary.  If classname is a null ptr
// or blank string, no class selection is done.  If classname is
// provided, the qualifying object must InheritFrom() or be a classname.
// The objname is optional, but, if filled, will further qualify the
// selection by requiring agreement with the GetName() method of the
// selected object.

   TString classtr("");
   if (classname)
      classtr.Append(TString(classname).Strip(TString::kBoth));

   TString objstr("");
   if (objname)
     objstr.Append(TString(objname).Strip(TString::kBoth));

   TObjArrayIter itr(&fTemporaries,kIterBackward);
   TObject *obj;

   while ((obj = itr())) {

// First check whether object InheritsFrom "classname"
     if (classtr.IsNull() || obj->InheritsFrom(classtr)) {

// Then check whether object name equals "objname"
       if (objstr.IsNull() || (objstr == obj->GetName()))
         return obj;
     }
   }
   return 0;

}

//_____________________________________________________________________________
const VldContext* RecMinos::GetVldContext() const
{
   // return a pointer to the VldContext in the header
   // (if there is one, otherwise 0 ptr) 
   const RecMinosHdr* head = GetHeader();
   if (head) return &(head->GetVldContext());
   return 0;
}

//_____________________________________________________________________________
void RecMinos::Print(Option_t * /* option */) const
{
   cout << "RecMinos::Print Header: " << endl;
   if (fHeader) fHeader -> Print();
   else         cout << "  ... no RecMinosHdr" << endl;
   fJobHistory.Print();
   
   TObject *obj;

   cout << "RecMinos::Print Components: " << endl;
   TObjArrayIter itr(&fComponents);
   while ((obj = itr())) {
      cout << obj->ClassName() << " " << obj->GetName() << endl;
   }

}

//_____________________________________________________________________________

void RecMinos::HasBeenModified() {
  //
  //  Purpose:  Handle generic record tasks appropriate for when record
  //            has been newly modified.
  //
  //  Arguments: none.
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  // 
  //  Notes:  The default behavior provided by this method is to clear
  //          the Registry value associated with the key "outstream" in
  //          the Registry fTempTags data member.  This indicates to
  //          any output module(s) in the user's job path(s) that the modified
  //          record should be re-persisted.
  // 

  fTempTags.RemoveKey("outstream");
  return;

}

//_____________________________________________________________________________

void RecMinos::PersistedToOutputStream(const char* stream,
                      const char* file, const char* tree, int index) {
  //
  //  Purpose:  Mark the record as having been stored in the named stream,file,
  //            tree, tree index location.
  //
  //  Arguments: stream name, file name, tree name, tree index to which record 
  //             was stored.  
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  // 
  //  Notes:  The output stream,file,tree,treeindex will be stored in
  //          Registry fTempTags in the following manner:
  //          key         type/value
  //          ===         ==========
  //          "outstream" Registry/see below:
  //                      key     type/value
  //                      ===     ==========
  //                      "nout"  int/# times this record has been persisted
  //                       "0"    Registry/see below:
  //                       "1"    Registry/   "
  //                       ...    Registry/   "
  //                     "nout-1" Registry/   "
  //                              key      type/value
  //                              ===      ==========
  //                              "stream" const char*/output stream name
  //                              "file"   const char*/output file name
  //                              "tree"   const char*/output tree name
  //                              "index"  int        /output tree index
  //          

  Registry outStreamRegistry;
  int nout = 0;
  if ( fTempTags.Get("outstream",outStreamRegistry) ) {
    outStreamRegistry.Get("nout",nout); 
  }
  outStreamRegistry.UnLockValues();

  // New output stream registry
  Registry newOutStream;
  newOutStream.Set("stream",stream);
  newOutStream.Set("file",file);
  newOutStream.Set("tree",tree);
  newOutStream.Set("index",index);

  // Insert new output stream registry at key nout of "outstream" registry
  char cnoutkey[20];
  sprintf(cnoutkey,"%i",nout);
  outStreamRegistry.Set(cnoutkey,newOutStream);
  nout++;
  outStreamRegistry.Set("nout",nout); 
  outStreamRegistry.LockValues();
  
  // Store revised "outstream" registry

  fTempTags.UnLockValues();
  fTempTags.Set("outstream",outStreamRegistry);
  fTempTags.LockValues();

}

//_____________________________________________________________________________

bool RecMinos::IsPersistedToOutputStream(const char* stream,
                          const char* file,const char* tree,int index) const {
  //
  //  Purpose:  Check to see if record has been persisted to the output
  //            stream/file/tree/tree index of interest. 
  //
  //  Arguments: stream/tree/file/tree index of interest.  If a value is
  //             left at default ("" for stream/tree/file, or -1 for index),
  //             that argument will not be checked. 
  //
  //  Return:  true or false. Result will be true if all non-default arguments 
  //           match those of one of the output streams to which this record
  //           has been persisted.
  //
  //  Contact:   S. Kasahara
  // 

  std::string s(stream);
  std::string f(file);
  std::string t(tree);

  Registry outStreamRegistry;
  int nout = 0;
  if ( fTempTags.Get("outstream",outStreamRegistry) ) {
    outStreamRegistry.Get("nout",nout);
    for ( int iout = 0; iout < nout; iout++) {
      char cioutkey[20];
      sprintf(cioutkey,"%i",iout);
      Registry outStream;
      outStreamRegistry.Get(cioutkey,outStream);
      bool isMatch = true;
      if ( !s.empty() ) {
        const char* cstream = 0;
        outStream.Get("stream",cstream);
        if ( std::string(cstream) != s ) isMatch = false;
      }        
      if ( !f.empty() ) {
        const char* cfile = 0;
        outStream.Get("file",cfile);
        if ( std::string(cfile) != f ) isMatch = false;
      }

      if ( !t.empty() ) {
        const char* ctree = 0;
        outStream.Get("tree",ctree);
        if ( std::string(ctree) != t ) isMatch = false;
      }
      if ( index > -1 ) {
        int storedindex = -1;
        outStream.Get("index",storedindex);
        if ( storedindex != index ) isMatch = false;
      }
      if ( isMatch ) {
        return true;  // found match in registry
      }
    } 
  }

  return false; // failed to find match in registry

}


//_____________________________________________________________________________

bool RecMinos::IsTransient() const {
  //
  //  Purpose:  If IsTransient (def), record will exist in memory for one
  //            job cycle only. 
  //
  //  Arguments: none.
  //
  //  Return:  true or false. 
  //
  //  Contact:   S. Kasahara
  // 

  int isTransient = 1;
  fTempTags.Get("isTransient",isTransient);
  return ( isTransient ) ? true : false;

}


//_____________________________________________________________________________

void RecMinos::SetTransient(bool isTransient) {
  //
  //  Purpose:  Set transient state of record.  If set true(def), record will
  //            exist in memory for one job cycle only.
  //
  //  Arguments: true or false.
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  // 

  fTempTags.UnLockValues();
  if ( isTransient ) fTempTags.Set("isTransient",1);
  else fTempTags.Set("isTransient",0);
  fTempTags.LockValues();
  return;

}

//_____________________________________________________________________________

---