include/Geant4/G4VScoreWriter.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 //
0027 //
0028
0029 #ifndef G4VScoreWriter_h
0030 #define G4VScoreWriter_h 1
0031
0032 #include "globals.hh"
0033 class G4VScoringMesh;
0034
0035 // class description:
0036 //
0037 //  This class represents storing the scored quantity into a file.
0038 //
0039
0040 class G4VScoreWriter
0041 {
0042  public:
0043   G4VScoreWriter() = default;
0044   virtual ~G4VScoreWriter() = default;
0045
0046  public:
0047   // store a quantity into a file
0048   virtual void DumpQuantityToFile(const G4String& psName,
0049                                   const G4String& fileName,
0050                                   const G4String& option);
0051   // store all quantities into a file
0052   virtual void DumpAllQuantitiesToFile(const G4String& fileName,
0053                                        const G4String& option);
0054
0055   // set a socring mesh to retrieve its quantities
0056   void SetScoringMesh(G4VScoringMesh* sm);
0057   // set a verbose level
0058   inline void SetVerboseLevel(G4int vl) { verboseLevel = vl; }
0059   inline void SetFactor(G4double val = 1.0) { fact = val; }
0060   inline G4double GetFactor() const { return fact; }
0061
0062  protected:
0063   // get an index from (x,y,z)
0064   G4int GetIndex(G4int x, G4int y, G4int z) const;
0065
0066  protected:
0067   G4int fNMeshSegments[3] = {0, 0, 0};  // number of segments of the mesh
0068   G4VScoringMesh* fScoringMesh = nullptr;
0069   G4int verboseLevel = 0;
0070   G4double fact = 1.0;
0071 };
0072
0073 #endif