PerStream.cxx

Go to the documentation of this file.

//
// PerStream
//
// Package: Per (Persistency).
//
// S. Kasahara 04/2001
//
// Purpose: Base class for managing an individual data stream.  A data
//          stream serves data to/from a ROOT TTree in a ROOT TFile.
//          The user should use the PerStreamManager and derived classes to 
//          open and close PerStreams.   
//

#include "TTree.h"
#include "TFile.h"
#include "Persistency/PerFileManager.h"
#include "Persistency/PerStream.h"
#include "Record/RecRecord.h"
#include "MessageService/MsgService.h"

CVSID("$Id: PerStream.cxx,v 1.18 2009/01/05 04:37:56 schubert Exp $");

std::ostream& operator<<(std::ostream& ms, const PerStream& ps) {
  return ps.Print(ms);
}

ClassImp(PerStream)

//   Definition of static data members
//   *********************************


// Definition of methods (alphabetical order)
// ***************************************************

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

void PerStream::Close() {
  //
  //  Purpose:  Close the stream.
  //
  //  Arguments: none.
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  // 

  CloseFile();  // close file for this stream

}

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

void PerStream::CloseFile() {
  //
  //  Purpose:  Close current file serving this stream.
  //
  //  Arguments: none.
  //
  //  Return: none.
  //
  //  Contact:   S. Kasahara
  // 

  if ( fPerOwned && fTObject ) {
    delete fTObject;
  }
  fPerOwned = false;
  fTObject = 0;  // the cached object is not owned by the stream.

  // delete TTree.  This also deletes managed TBranches.
  if( fTTree) delete fTTree; fTTree = 0; fTBranch = 0; 
 
  // Starting with root ~v5.13 the fTTree dtor will create
  // a new object at the fTObject ptr address, but only 
  // some of the time (oddly). Check to see if a new object has
  // been created by the TTree dtor, and delete it if so.
  if ( fTObject ) delete fTObject;  fTObject = 0;
  
  if (!fFullFilePathName.empty()) {
    PerFileManager& filemanager = PerFileManager::Instance();
    filemanager.CloseFile(fFullFilePathName);
    fFullFilePathName = "";
    fTFile = 0;
    fEntry = -1;
  } 

  return;

}

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

PerStream::PerStream(std::string treename) : 
  fTreeName(treename),fStreamName(""),fClassName(""),
  fFullFilePathName(""),fTFile(0),fTTree(0),fTBranch(0),fTObject(0),
  fEntry(-1),fEnable(true),fPerOwned(false),fPerOwnedDisabled(false),
  fErrorCode(Per::kErrSuccess),fTestMode(false) {
  //
  //  Purpose:  Default constructor.
  //
  //  Arguments: 
  //    treename   string   name of the tree served by this stream.
  //    streamname string   name of this stream (default = treename)
  //  Return:    n/a.
  //
  //  Contact:   S. Kasahara
  // 

  TTree::SetBranchStyle(1);  // use new 3.01 style of creating branches

}

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

PerStream::~PerStream() {
  //
  //  Purpose:  PerStream destructor.  Closes stream and retrieves
  //            allocated memory.
  //
  //  Contact:   S. Kasahara
  // 

  Close();

}

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

void PerStream::SetPerOwned(bool perowned) {
  //
  // Purpose: Designate this stream as owning it's records.  This will
  //          allow it to reuse the same record on each stream read to increase
  //          the efficiency of i/o.
  //
  // Contact: S. Kasahara
  //

  if ( perowned && IsPerOwnedDisabled() ) {
    MSG("Per",Msg::kWarning) 
      << "PerStream::SetPerOwned called for stream " << GetStreamName()
      << " but user has SetPerOwnedDisabled for this stream. Ignored." 
      << endl;
  }
  else fPerOwned = perowned;

  return;
  
}

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

void PerStream::SetPerOwnedDisabled(bool perowneddisabled) {
  //
  // Purpose: Disable Per ownership for this stream.  
  //
  // Contact: S. Kasahara
  //

  if ( perowneddisabled && IsPerOwned() ) fPerOwned = false;
  fPerOwnedDisabled = perowneddisabled;

  return;
  
}

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

std::ostream& PerStream::Print(std::ostream& ms) const {
  //
  //  Purpose:  Print status of stream on std::ostream.
  //
  //  Arguments: ms std::ostream to display on.
  //
  //  Return:  std::ostream reference.
  //
  //  Contact:   S. Kasahara
  // 

  ms << "Stream serving tree " << fTreeName 
     << (IsOpen() ? " is open " : " is not open ")      << "and" 
     << (IsEnabled() ? " enabled." : " disabled.") << endl;
  if ( IsOpen() ) {
    ms << "  Total entries in stream tree = " << (Int_t)fTTree ->GetEntries() 
       << endl;
    ms << "  The current file assigned to this stream is " 
       << fTTree->GetCurrentFile()->GetName() << endl; 
  }
  ms << "  This stream serves objects of classname " << fClassName << "." 
     << endl;

  return ms;

}

void PerStream::Reset(bool ishard) {
  //
  //  Purpose:  Reset.
  //
  //  Arguments: ishard, true => implies delete or Clear object (object owned) 
  //                    false => implies set object ptr to 0 (default)
  //
  //  Return: none.
  //
  //  Contact:   S. Kasahara
  // 

  if (!fTObject) return;
  
  if ( IsPerOwned() ) {
    if (ishard) {
      RecRecord* recrecord = dynamic_cast<RecRecord*>(fTObject);
      recrecord -> Clear(); 
      recrecord -> HasBeenModified(); // clear tags so that i/o will repersist
    }
  }
  else {
    if ( ishard ) {
      if ( fTObject ) delete fTObject; 
      fTObject = 0;
    }
    else {
      // object cache not owned, reset
      fTObject = 0;
    }
  }

  return;

}

---