include/Geant4/G4VEMDataSet.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 // Author: Maria Grazia Pia (Maria.Grazia.Pia@cern.ch)
0029 //
0030 // History:
0031 // -----------
0032 // 31 Jul 2001   MGP                 Created
0033 //
0034 // 15 Jul 2009   N.A.Karakatsanis    New methods added for loading logarithmic data
0035 //                                   to enhance computing performance of interpolation
0036 //
0037 // 24 Dec 2010   V.Ivanchenko moved constructor and destructor to the source
0038 //
0039 // -------------------------------------------------------------------
0040
0041 // Class description:
0042 // Low Energy Electromagnetic Physics
0043 // Data set for an electromagnetic physics process
0044 // A strategy pattern is used to encapsulate algorithms for data interpolation
0045 // Further documentation available from http://www.ge.infn.it/geant4/lowE
0046
0047 // -------------------------------------------------------------------
0048
0049 #ifndef  G4VEMDATASET_HH
0050 #define  G4VEMDATASET_HH 1
0051
0052 #include "globals.hh"
0053 #include "G4DataVector.hh"
0054
0055 class G4VEMDataSet
0056 {
0057 public:
0058   explicit G4VEMDataSet();
0059   virtual ~G4VEMDataSet();
0060
0061   virtual G4double FindValue(G4double x, G4int componentId = 0) const = 0;
0062
0063   virtual void PrintData(void) const = 0;
0064
0065   virtual const G4VEMDataSet* GetComponent(G4int componentId) const = 0;
0066   virtual void AddComponent(G4VEMDataSet* dataSet) = 0;
0067   virtual size_t NumberOfComponents(void) const = 0;
0068
0069   virtual const G4DataVector& GetEnergies(G4int componentId) const = 0;
0070   virtual const G4DataVector& GetData(G4int componentId) const = 0;
0071   virtual const G4DataVector& GetLogEnergies(G4int componentId) const = 0;
0072   virtual const G4DataVector& GetLogData(G4int componentId) const = 0;
0073
0074   virtual void SetEnergiesData(G4DataVector* x, G4DataVector* data, G4int component=0) = 0;
0075   virtual void SetLogEnergiesData(G4DataVector* x,
0076                                   G4DataVector* data,
0077                                   G4DataVector* Log_x,
0078                                   G4DataVector* Log_data,
0079                                   G4int component=0) = 0;
0080
0081   virtual G4bool LoadData(const G4String& fileName) = 0;
0082   virtual G4bool LoadNonLogData(const G4String& fileName) = 0;
0083
0084   virtual G4bool SaveData(const G4String& fileName) const = 0;
0085
0086   virtual G4double RandomSelect(G4int componentId = 0) const = 0;
0087
0088   G4VEMDataSet(const G4VEMDataSet& copy) = delete;
0089   G4VEMDataSet& operator=(const G4VEMDataSet& right) = delete;
0090 };
0091 #endif /* G4VEMDATASET_HH */