G4HnManager.hh

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.          *
// ********************************************************************
//
// $Id: G4HnManager.hh 70604 2013-06-03 11:27:06Z ihrivnac $

// Class for management of G4HnInformation.
// It implements functions handling the added H1/H2 information
// (not available in g4tools). 
//
// Author: Ivana Hrivnacova, 18/06/2013  (ivana@ipno.in2p3.fr)

#ifndef G4HnManager_h
#define G4HnManager_h 1

#include "G4BaseAnalysisManager.hh"
#include "G4HnInformation.hh"
#include "globals.hh"

#include <vector>

class G4HnManager : public G4BaseAnalysisManager
{
  public:
    G4HnManager(const G4String& hnType,
                const G4AnalysisManagerState& state);
    virtual ~G4HnManager();

    // Methods to manipulate additional information
     
    void AddH1Information(const G4String& name, 
                          const G4String& unitName,
                          const G4String& fcnName,
                          G4double unit, 
                          G4Fcn fx,
                          G4BinScheme binScheme);
    void AddH2Information(const G4String& name,
                          const G4String& xunitName, 
                          const G4String& yunitName,
                          const G4String& xfcnName,
                          const G4String& yfcnName,
                          G4double xunit, G4double yunit, 
                          G4Fcn fx, G4Fcn fy,
                          G4BinScheme xBinScheme, G4BinScheme yBinScheme); 
    void AddH3Information(const G4String& name,
                          const G4String& xunitName, 
                          const G4String& yunitName,
                          const G4String& zunitName,
                          const G4String& xfcnName,
                          const G4String& yfcnName,
                          const G4String& zfcnName,
                          G4double xunit, G4double yunit, G4double zunit, 
                          G4Fcn fx, G4Fcn fy, G4Fcn fz,
                          G4BinScheme xBinScheme, G4BinScheme yBinScheme,
                          G4BinScheme zBinScheme); 
    // Access methofd    
    G4HnInformation* GetHnInformation(G4int id,
                          G4String functionName = "",
                          G4bool warn = true) const;

    G4HnDimensionInformation* GetHnDimensionInformation(G4int id,
                          G4int dimension,
                          G4String functionName = "",
                          G4bool warn = true) const;

    const std::vector<G4HnInformation*>& GetHnVector() const;
    G4int GetNofHns() const;
    G4String GetHnType() const;

    // Activation option

    // Return false if activation is enabled and there is no object activated,
    // return true otherwise
    G4bool IsActive() const;

    // ASCII option

    // Return false if there is no object selected for ASCII output,
    // return true otherwise
    G4bool IsAscii() const;
    
    // Function implementing public analsi manager interface
    //
    
    void  SetActivation(G4bool activation);
    void  SetActivation(G4int id, G4bool activation);
    void  SetAscii(G4int id, G4bool ascii);

    // Access to Hn additional information
    G4String GetName(G4int id) const;
    G4double GetXUnit(G4int id) const;
    G4double GetYUnit(G4int id) const;
    G4double GetZUnit(G4int id) const;
    G4bool   GetActivation(G4int id) const;
    G4bool   GetAscii(G4int id) const;

  private:
    // Data members
    G4String  fHnType;
    G4int     fNofActiveObjects;
    G4int     fNofAsciiObjects;

    // Additional histograms/ntuple properties not included in tools
    std::vector<G4HnInformation*> fHnVector;
};

inline G4int G4HnManager::GetNofHns() const
{ return fHnVector.size(); }
  
inline G4String G4HnManager::GetHnType() const
{ return fHnType; }

inline const std::vector<G4HnInformation*>& G4HnManager::GetHnVector() const
{ return fHnVector; }

#endif