G4HnManager.cc

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
 
// Author: Ivana Hrivnacova, 18/06/2013  ([email protected])
 
#include "G4HnManager.hh"
#include "G4HnMessenger.hh"
 
#include "G4AnalysisUtilities.hh"
#include "G4VFileManager.hh"
 
#include <utility>
 
using namespace G4Analysis;
using std::to_string;
 
//_____________________________________________________________________________
G4HnManager::G4HnManager(G4String hnType, const G4AnalysisManagerState& state)
  : G4BaseAnalysisManager(state), fHnType(std::move(hnType))
{}
 
//_____________________________________________________________________________
G4HnManager::~G4HnManager()
{
  for ( auto info : fHnVector ) {
    delete info;
  }
}
 
//
// private methods
//
 
//_____________________________________________________________________________
void  G4HnManager::SetActivation(G4HnInformation* info, G4bool activation)
{
// Set activation to a given object
 
  // Do nothing if activation does not change
  if ( info->GetActivation() == activation ) return;
 
  // Change activation and account it in fNofActiveObjects
  info->SetActivation(activation);
  if (activation) {
    fNofActiveObjects++;
  }
  else {
    fNofActiveObjects--;
  }
}
 
//_____________________________________________________________________________
void  G4HnManager::SetPlotting(G4HnInformation* info, G4bool plotting)
{
  // Do nothing if ascii does not change
  if ( info->GetPlotting() == plotting ) return;
 
  // Change Plotting and account it in fNofPlottingObjects
  info->SetPlotting(plotting);
  if (plotting) {
    fNofPlottingObjects++;
  }
  else {
    fNofPlottingObjects--;
  }
}
 
//_____________________________________________________________________________
void  G4HnManager::SetFileName(G4HnInformation* info, const G4String& fileName)
{
  // Do nothing if file name does not change
  if ( info->GetFileName() == fileName ) return;
 
  auto hnFileName = fileName;
  auto extension = GetExtension(fileName);
  if (extension.size() != 0u) {
    // Check if valid extension (if present)
    auto output = G4Analysis::GetOutput(extension);
    if ( output == G4AnalysisOutput::kNone ) {
      Warn("The file extension " + extension + " is not supported.",
        fkClass, "SetFileName");
      return;
    }
  }
  else {
    if (fDefaultFileType.size() != 0u) {
      //add extension if missing and file type is defined
      hnFileName = fileName + "." + fDefaultFileType;
    }
  }
 
  // Save the info and account a new file name if file manager
  info->SetFileName(hnFileName);
  if (fFileManager) {
    fFileManager->AddFileName(hnFileName);
  } else {
    Warn("Failed to set fileName " + fileName +
         " for object " + info->GetName() + ".\nFile manager is not set.",
         fkClass, "SetFileName");
    return;
  }
 
  if ( hnFileName != "" ) {
    fNofFileNameObjects++;
  } else {
    fNofFileNameObjects--;
  }
}
 
//
// public methods
//
 
//_____________________________________________________________________________
void G4HnManager::CreateMessenger()
{
  fMessenger = std::make_unique<G4HnMessenger>(*this);
}
 
//_____________________________________________________________________________
void G4HnManager::AddHnInformation(G4HnInformation* info)
{
  // Add new information
 
  fHnVector.push_back(info);
  ++fNofActiveObjects;
}
 
//_____________________________________________________________________________
void G4HnManager::AddHnInformation(G4HnInformation* info, G4int index)
{
  // Replace the information at 'index' position with new one.
  // Update new information with the previous one settings if the
  // previous histogram was deleted with 'keepSetting' set true.
 
  auto previousInfo = fHnVector[index];
  if (previousInfo->GetDeletedPair().second) {
    info->Update(*previousInfo);
  }
  delete previousInfo;
 
  fHnVector[index] = info;
 
  if (info->GetActivation()) { ++fNofActiveObjects; }
  if (info->GetAscii())      { ++fNofAsciiObjects; }
  if (info->GetPlotting())   { ++fNofPlottingObjects; }
  if (! info->GetFileName().empty()) { ++fNofFileNameObjects; }
}
 
//_____________________________________________________________________________
void G4HnManager::SetHnDeleted(G4HnInformation* info, G4bool keepSetting)
{
  info->SetDeleted(true, keepSetting);
 
  if (info->GetActivation()) { --fNofActiveObjects; }
  if (info->GetAscii())      { --fNofAsciiObjects; }
  if (info->GetPlotting())   { --fNofPlottingObjects; }
  if (! info->GetFileName().empty()) { --fNofFileNameObjects; }
}
 
//_____________________________________________________________________________
void G4HnManager::ClearData()
{
  for ( auto info : fHnVector ) {
    delete info;
  }
  fHnVector.clear();
  SetLockFirstId(false);
}
 
//_____________________________________________________________________________
G4HnInformation* G4HnManager::GetHnInformation(G4int id,
                                 std::string_view functionName, G4bool warn) const
{
  G4int index = id - fFirstId;
  if ( index < 0 || index >= G4int(fHnVector.size()) ) {
    if ( warn ) {
      Warn(fHnType + " histogram " + to_string(id) + " does not exist.",
        fkClass, functionName);
    }
    return nullptr;
  }
  return fHnVector[index];
}
 
//_____________________________________________________________________________
G4HnDimensionInformation* G4HnManager::GetHnDimensionInformation(G4int id,
                                G4int dimension,
                                std::string_view functionName, G4bool warn) const
{
  auto info = GetHnInformation(id, functionName, warn);
  if (info == nullptr) return nullptr;
 
  return info->GetHnDimensionInformation(dimension);
}
 
//_____________________________________________________________________________
G4bool G4HnManager::IsActive() const
{
  return ( fNofActiveObjects > 0 );
}
 
//_____________________________________________________________________________
G4bool G4HnManager::IsAscii() const
{
  return ( fNofAsciiObjects > 0 );
}
 
//_____________________________________________________________________________
G4bool G4HnManager::IsPlotting() const
{
  return ( fNofPlottingObjects > 0 );
}
 
//_____________________________________________________________________________
G4bool G4HnManager::IsFileName() const
{
  return ( fNofFileNameObjects > 0 );
}
 
//_____________________________________________________________________________
void  G4HnManager::SetActivation(G4int id, G4bool activation)
{
// Set activation to a given object
 
  auto info = GetHnInformation(id, "SetActivation");
 
  if (info == nullptr) return;
 
  SetActivation(info, activation);
}
 
//_____________________________________________________________________________
void  G4HnManager::SetActivation(G4bool activation)
{
// Set activation to all objects of the given type
 
  //std::vector<G4HnInformation*>::iterator it;
  //for ( it = fHnVector.begin(); it != fHnVector.end(); it++ ) {
  //   G4HnInformation* info = *it;
 
  for ( auto info : fHnVector )  {
    SetActivation(info, activation);
  }
}
 
//_____________________________________________________________________________
void  G4HnManager::SetAscii(G4int id, G4bool ascii)
{
  auto info = GetHnInformation(id, "SetAscii");
 
  if (info == nullptr) return;
 
  // Do nothing if ascii does not change
  if ( info->GetAscii() == ascii ) return;
 
  // Change ascii and account it in fNofAsciiObjects
  info->SetAscii(ascii);
  if (ascii) {
    fNofAsciiObjects++;
  }
  else {
    fNofAsciiObjects--;
  }
}
 
//_____________________________________________________________________________
void  G4HnManager::SetPlotting(G4int id, G4bool plotting)
{
  auto info = GetHnInformation(id, "SetPlotting");
 
  if (info == nullptr) return;
 
  SetPlotting(info, plotting);
}
 
//_____________________________________________________________________________
void  G4HnManager::SetPlotting(G4bool plotting)
{
// Set plotting to all objects of the given type
 
  for ( auto info : fHnVector )  {
    SetPlotting(info, plotting);
  }
}
 
//_____________________________________________________________________________
void  G4HnManager::SetFileName(G4int id, const G4String& fileName)
{
  auto info = GetHnInformation(id, "SetFileName");
 
  if (info == nullptr) return;
 
  SetFileName(info, fileName);
}
 
//_____________________________________________________________________________
void  G4HnManager::SetFileName(const G4String& fileName)
{
// Set plotting to all objects of the given type
 
  for ( auto info : fHnVector )  {
    SetFileName(info, fileName);
  }
}
 
//_____________________________________________________________________________
G4bool G4HnManager::SetAxisIsLog(unsigned int idim, G4int id, G4bool isLog)
{
  auto info = GetHnInformation(id, "SetAxisIsLog");
 
  if (info == nullptr) return false;
 
  info->SetIsLogAxis(idim, isLog);
  return true;
}
 
//_____________________________________________________________________________
G4String G4HnManager::GetName(G4int id) const
{
  auto info = GetHnInformation(id, "GetName");
 
  if (info == nullptr) return "";
 
  return info->GetName();
}
 
//_____________________________________________________________________________
G4double G4HnManager::GetUnit(unsigned int idim, G4int id) const
{
  auto info = GetHnDimensionInformation(id, idim, "GetXUnit");
 
  if (info == nullptr) return 1.0;
 
  return info->fUnit;
}
 
//_____________________________________________________________________________
G4bool G4HnManager::GetAxisIsLog(unsigned int idim, G4int id) const
{
  auto info = GetHnInformation(id, "GetXAxisIsLog");
 
  if (info == nullptr) return false;
 
  return info->GetIsLogAxis(idim);
}
 
//_____________________________________________________________________________
G4bool G4HnManager::GetActivation(G4int id) const
{
  auto info = GetHnInformation(id, "GetActivation");
 
  if (info == nullptr) return true;
 
  return info->GetActivation();
}
 
//_____________________________________________________________________________
G4bool G4HnManager::GetAscii(G4int id) const
{
  auto info = GetHnInformation(id, "GetAscii");
 
  if (info == nullptr) return false;
 
  return info->GetAscii();
}
 
//_____________________________________________________________________________
G4bool G4HnManager::GetPlotting(G4int id) const
{
  auto info = GetHnInformation(id, "GetPlotting");
 
  if (info == nullptr) return false;
 
  return info->GetPlotting();
}
 
//_____________________________________________________________________________
G4String G4HnManager::GetFileName(G4int id) const
{
  auto info = GetHnInformation(id, "GetFileName");
 
  if (info == nullptr) return "";
 
  return info->GetFileName();
}