PerFileManager Class Reference

#include <PerFileManager.h>

List of all members.

Public Types
typedef map< string, PerFile * >::iterator	FileMapItr
typedef map< string, PerFile * >::const_iterator	FileMapConstItr
Public Member Functions
virtual	~PerFileManager ()
UInt_t	GetNumFile () const
Per::EErrorCode	GetErrorCode () const
const PerFile *	GetOpenedFile (string fullfilepathname) const
std::ostream &	Print (std::ostream &s) const
const PerFile *	ChangeFile (std::string oldfilepathname, std::string newfilepathname, TFile *newfileptr)
const PerFile *	OpenFile (string fullfilepathname, Per::EAccessMode accessmode)
void	CloseFile (string fullfilepathname)
void	CloseAll ()
Static Public Member Functions
static PerFileManager &	Instance ()
Protected Member Functions
	PerFileManager ()
Private Member Functions
	PerFileManager (PerFileManager &)
PerFileManager &	operator= (const PerFileManager &)
Private Attributes
map< string, PerFile * >	fFileMap
Per::EErrorCode	fErrorCode
Static Private Attributes
static PerFileManager *	fgInstance = 0
Friends
struct	Cleaner
Classes
struct	Cleaner

---

Detailed Description

Definition at line 32 of file PerFileManager.h.

---

Member Typedef Documentation

typedef map<string,PerFile*>::const_iterator PerFileManager::FileMapConstItr

Definition at line 38 of file PerFileManager.h.

typedef map<string,PerFile*>::iterator PerFileManager::FileMapItr

Definition at line 37 of file PerFileManager.h.

---

Constructor & Destructor Documentation

PerFileManager::~PerFileManager

(

)

[virtual]

Definition at line 270 of file PerFileManager.cxx.

References CloseAll().

                                {
  //  Purpose:  Destructor.
  //
  //  Arguments: none.
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  //
  
  // Close all managed files and retrieve allocated memory
  CloseAll();

}

PerFileManager::PerFileManager

(

)

[protected]

Definition at line 252 of file PerFileManager.cxx.

Referenced by Instance().

                               : fErrorCode(Per::kErrSuccess) {
  // Purpose: Default constructor.
  //
  // Arguments: none.
  //
  // Return: none.
  //
  // Contact:  S. Kasahara
  //
  // Notes: Not called directly, use PerFileManager::Instance() instead.

  // Initialize environment variable to force use of TNetFile in TFile::Open 
  // when path to file is prefaced by "root(s):", even when file path host
  // indicates a local file.
  gEnv -> SetValue("TFile.ForceRemote",1);

}

PerFileManager::PerFileManager

(

PerFileManager &

)

[inline, private]

Definition at line 64 of file PerFileManager.h.

{ abort(); }

---

Member Function Documentation

const PerFile * PerFileManager::ChangeFile	(	std::string	oldfilepathname,
		std::string	newfilepathname,
		TFile *	newfileptr
	)

Definition at line 41 of file PerFileManager.cxx.

References Msg::kWarning, and MSG.

Referenced by PerOutputStream::ChangeFile().

                                                                            {
  //  Purpose:  This method is useful when TTree::Fill has closed the current
  //            file and opened a new one with extension _1 because it has
  //            detected that the file limit of 2 GByte is near.  Its purpose
  //            is to swap the new file name and file pointer for the old
  //            filename and pointer in its file map, without actually
  //            closing the old file or opening the new file, since this
  //            has already been done by root.
  //
  //  Arguments:oldfilepathname  full file path name of old file.
  //            newfilepathname  full file path name of new file.
  //            newfileptr       pointer to new file opened by root.
  //
  //  Return:  pointer to new PerFile.
  //
  //  Contact:   S. Kasahara
  //
  //  Notes: Caution: this method is only meant to be used under the
  //         special circumstances described above. 
  //

  FileMapItr itr = fFileMap.find(oldfilepathname);

  if ( itr == fFileMap.end() ) {
    // Nothing to be done if conversion already made
    FileMapItr newItr = fFileMap.find(newfilepathname);
    if ( newItr == fFileMap.end() ) {
      MSG("Per",Msg::kWarning) << "ChangeFile unable to find old file "
         << oldfilepathname << " or new file " << newfilepathname 
                               << " in file map." << endl; 
      return (PerFile*)0;
    }
    else return itr->second;
  }

  // Else convert PerFile attributes and replace entry in map
  PerFile* perFile = itr->second;
  perFile -> ChangeFile(newfilepathname,newfileptr);

  fFileMap.erase(itr);  // erase old entry
  fFileMap[newfilepathname] = perFile;  // replace it with new

  return perFile;

}

void PerFileManager::CloseAll

(

)

Definition at line 88 of file PerFileManager.cxx.

References fFileMap, and Munits::second.

Referenced by ~PerFileManager().

                              {
  //  Purpose:  Close all files managed by PerFileManager.
  //
  //  Argument: none.
  //
  //  Return:  none.
  //
  //  Contact:   S. Kasahara
  //
  //  Notes: Files are closed regardless of remaining number of clients.
  //


  for (FileMapItr itr = fFileMap.begin(); itr != fFileMap.end(); ++itr) {
    PerFile *file = itr -> second;
    file -> Close(true); // close file 
    delete file; // retrieve file memory
  }
  fFileMap.clear(); // clear all map entries

}

void PerFileManager::CloseFile

(

string

fullfilepathname

)

Definition at line 110 of file PerFileManager.cxx.

References fFileMap, Msg::kInfo, MSG, and Munits::second.

Referenced by IoFileListItem::BuildDefStreamList(), and PerStream::CloseFile().

                                                      {
  //  Purpose:  Close file with name fullfilepathname.  If file has more
  //            than one client, number of clients is just decremented by
  //            one and the file is left open.
  //
  //  Argument: fullfilepathname string containing name of file of interest.
  //
  //  Return:  none
  //
  //  Contact:   S. Kasahara
  //

  FileMapItr itr = fFileMap.find(fullfilepathname);
  if (itr != fFileMap.end()) {
    UInt_t clientsleft = (itr -> second) -> Close();
    if(clientsleft <= 0) {
      // Retrieve file memory and clear entry from map 
      delete (itr->second); 
      fFileMap.erase(itr);
    }
  }
  else {
    MSG("Per",Msg::kInfo) << "Unable to close file " << fullfilepathname <<
      ". File was not opened by PerFileManager. " << endl;
  }
  
}

Per::EErrorCode PerFileManager::GetErrorCode

(

)

const [inline]

Definition at line 45 of file PerFileManager.h.

References fErrorCode.

Referenced by OpenFile(), and PerInputStream::SetFile().

{return fErrorCode;}

UInt_t PerFileManager::GetNumFile

(

)

const [inline]

Definition at line 44 of file PerFileManager.h.

References fFileMap.

Referenced by Print().

{return fFileMap.size();}

const PerFile * PerFileManager::GetOpenedFile

(

string

fullfilepathname

)

const

Definition at line 139 of file PerFileManager.cxx.

References fFileMap, and Munits::second.

Referenced by DDSChildServer::Next(), and PerInputStream::UpdateTree().

                                                                          {
  //  Purpose:  Retrieve file corresponding to fullfilepathname.
  //            File must have been previously opened with OpenFile method.
  //
  //  Argument: fullfilepathname string containing name of file of interest.
  //
  //  Return:  pointer to a constant PerFile. If file member with name
  //           fullfilepathname does not exist, returns (PerFile*)0.  
  //
  //  Contact:   S. Kasahara
  //
  //  Notes: User may not modify PerFile data directly.  All
  //         modifications should be handled through the PerFileManager. 

  FileMapConstItr citr = fFileMap.find(fullfilepathname);
  return (citr != fFileMap.end()) ? citr -> second : (PerFile*)0;

}

PerFileManager & PerFileManager::Instance

(

)

[static]

Definition at line 158 of file PerFileManager.cxx.

References fgInstance, PerFileManager(), and PerFileManager::Cleaner::UseMe().

Referenced by IoFileListItem::BuildDefStreamList(), PerOutputStream::ChangeFile(), PerStream::CloseFile(), DDSChildServer::Next(), PerInputStream::SetFile(), and PerInputStream::UpdateTree().

                                         {
  //  Purpose:  Return unique instance of PerFileManager, creating it
  //            if necessary.
  //
  //  Arguments: none.
  //
  //  Return:  reference to PerFileManager.
  //
  //  Contact:   S. Kasahara
  //

  static Cleaner cleaner; // Cleaner destructor provides cleanup of singleton
  if (fgInstance == 0) {
    cleaner.UseMe(); // dummy call to quiet compiler warnings
    fgInstance = new PerFileManager();
  }
  return *fgInstance;

}

const PerFile * PerFileManager::OpenFile	(	string	fullfilepathname,
		Per::EAccessMode	accessmode
	)

Definition at line 179 of file PerFileManager.cxx.

References fErrorCode, fFileMap, GetErrorCode(), Per::kErrFileConflict, Per::kErrFileError, and Per::kErrSuccess.

Referenced by IoFileListItem::BuildDefStreamList(), and PerInputStream::SetFile().

                                                                                          {
  //  Purpose:  Open file with name fullfilepathname in specified accessmode.
  //            If file is already open, adds a new client to this file if
  //            new accessmode is compatible with the accessmode in which the
  //            file was initially opened.
  //
  //  Arguments:fullfilepathname string containing full file path name of
  //                             file to be opened.  File may be local
  //                             or remote.  See PerFile::OpenFile
  //                             for information about the remote filename
  //                             format.
  //            accessmode       EAccessMode in which file is to be opened
  //                             (defined in Per.h).
  //                             kRead = open file in read only mode.
  //                             kNew = open new file in read/write. If file
  //                                    already exists, do not overwrite.
  //                             kRecreate = same as kNew, but if file already
  //                                         exists overwrite.
  //                             kUpdate = open existing file in read/write.
  //                                
  //
  //  Return:  pointer to a constant PerFile. If unable to open
  //           file, or if requested accessmode is incompatible with the
  //           accessmode in which the file was originally opened, 
  //           returns (PerFile*)0.
  //
  //  Contact:   S. Kasahara
  //
  //  Notes: User may not modify PerFile data directly.  All
  //         modifications should be handled through the PerFileManager.
  //         See PerFile::OpenFile for information about specifying
  //         the authentication information required for remote access.
  //         If file fails to open, PerFileManager::GetErrorCode can
  //         be used to determine source of failure.

  bool openok = false;

  fErrorCode = Per::kErrSuccess;

  PerFile* file = fFileMap[fullfilepathname];
  if (!file) {
    // File not found in map, need to create new one
    file = new PerFile(fullfilepathname,accessmode);
    fFileMap[fullfilepathname] = file;
    if(!file || !file -> IsOpen()) {
      fErrorCode = Per::kErrFileError;
      if (file) {
        fErrorCode = file -> GetErrorCode();
        delete file; file = 0; // retrieve memory
      }
#ifndef IRIX6
      fFileMap.erase(fullfilepathname); // erase entry from map
#else
      // erase entry from map -- SGI barfs at fFileMap.erase(fullfilepathname);
      FileMapItr itr = fFileMap.find(fullfilepathname);
      fFileMap.erase(itr);
#endif
    }
    else {
      openok = true;
    }  
  }
  else {
    // File has already been opened, attempt to add new client if 
    // accessmodes are compatible
    openok = file -> AddNewClient(accessmode);
    if (!openok) fErrorCode = Per::kErrFileConflict;
  }

  return (openok) ? file : (PerFile*)0;

}

PerFileManager& PerFileManager::operator=

(

const PerFileManager &

)

[inline, private]

Definition at line 65 of file PerFileManager.h.

      { abort(); return *this; }

std::ostream & PerFileManager::Print

(

std::ostream &

s

)

const

Definition at line 285 of file PerFileManager.cxx.

References fFileMap, GetNumFile(), and Munits::second.

Referenced by operator<<().

                                                      {
  //  Purpose:  Print current map of files maintained by file manager on
  //            ostream.
  //
  //  Arguments: ms ostream to display on.
  //
  //  Return:  ostream reference.
  //
  //  Contact:   S. Kasahara
  //

  ms << "Number of files currently open = " << GetNumFile() << "." << endl;

  int ifile=0;
  for (FileMapConstItr itr = fFileMap.begin(); itr != fFileMap.end(); ++itr) {
    ms << ++ifile << ")" << itr -> second;
  }

  return ms;
}

---

Friends And Related Function Documentation

friend struct Cleaner [friend]

Definition at line 80 of file PerFileManager.h.

---

Member Data Documentation

Per::EErrorCode PerFileManager::fErrorCode [private]

Definition at line 82 of file PerFileManager.h.

Referenced by GetErrorCode(), and OpenFile().

map<string,PerFile*> PerFileManager::fFileMap [private]

Definition at line 69 of file PerFileManager.h.

Referenced by CloseAll(), CloseFile(), GetNumFile(), GetOpenedFile(), OpenFile(), and Print().

PerFileManager * PerFileManager::fgInstance = 0 [static, private]

Definition at line 81 of file PerFileManager.h.

Referenced by Instance(), and PerFileManager::Cleaner::~Cleaner().

---

The documentation for this class was generated from the following files:

• PerFileManager.h
• PerFileManager.cxx

---