include/Geant4/G4VAccumulable.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 // Value type independent base class for accumulables handled by Geant4 analysis
0028 //
0029 // Author: Ivana Hrivnacova, IJCLab IN2P3/CNRS, 04/09/2015
0030
0031 #ifndef G4VAccumulable_h
0032 #define G4VAccumulable_h 1
0033
0034 #include "G4AccType.hh"
0035 #include "G4MergeMode.hh"
0036
0037 #include "globals.hh"
0038
0039 class G4VAccumulable
0040 {
0041   public:
0042     G4VAccumulable(G4MergeMode mergeMode = G4MergeMode::kAddition);
0043     G4VAccumulable(const G4String& name,
0044                    G4MergeMode mergeMode = G4MergeMode::kAddition);
0045     G4VAccumulable(const G4VAccumulable& rhs) = default;
0046     G4VAccumulable(G4VAccumulable&& rhs) = default;
0047     virtual ~G4VAccumulable() = default;
0048
0049     // Operators
0050     G4VAccumulable& operator=(const G4VAccumulable& rhs) = default;
0051     G4VAccumulable& operator=(G4VAccumulable&& rhs) = default;
0052
0053     // Methods
0054     virtual void Merge(const G4VAccumulable& other) = 0;
0055     virtual void Reset() = 0;
0056     virtual void Print(G4PrintOptions options = G4PrintOptions()) const;
0057     virtual void SetMergeMode(G4MergeMode value);
0058
0059     // Set methods
0060     void SetName(const G4String& name);
0061     void SetId(G4int id);
0062
0063     // Get methods
0064     G4String  GetName() const;
0065     G4MergeMode GetMergeMode() const;
0066     G4int GetId() const;
0067
0068     virtual G4AccType GetType() const { return G4AccType::kUser; }
0069
0070   protected:
0071     void PrintBase(G4PrintOptions options) const;
0072
0073     G4String  fName;
0074     G4MergeMode  fMergeMode = G4MergeMode::kAddition;
0075     G4int fId = G4Accumulables::kInvalidId;
0076  };
0077
0078 #include "G4VAccumulable.icc"
0079
0080 #endif
0081