include/Geant4/G4OrderedTable.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 // G4OrderedTable
0027 //
0028 // Class description:
0029 //
0030 // Utility class, defining an ordered collection of vectors of <G4double>.
0031
0032 // Author: M.Maire (LAPP), September 1996
0033 // Revisions: H.Kurashige (Kobe Univ.), January-September 2001
0034 // --------------------------------------------------------------------
0035 #ifndef G4OrderedTable_hh
0036 #define G4OrderedTable_hh 1
0037
0038 #include <vector>
0039
0040 #include "G4DataVector.hh"
0041 #include "globals.hh"
0042
0043 class G4OrderedTable : public std::vector<G4DataVector*>
0044 {
0045  public:
0046   G4OrderedTable() = default;
0047   // Default constructor
0048
0049   explicit G4OrderedTable(std::size_t cap);
0050   // Constructor given a 'capacity' defining the initial
0051   // number of elements (NULL pointers are filled up)
0052
0053   virtual ~G4OrderedTable() = default;
0054   // Empty Destructor
0055
0056   void clearAndDestroy();
0057   // Removes all elements and deletes all non-NULL pointers
0058
0059   G4bool Store(const G4String& filename, G4bool ascii = false);
0060   // Stores OrderedTable in a file (returns false in case of failure)
0061
0062   G4bool Retrieve(const G4String& filename, G4bool ascii = false);
0063   // Retrieves OrderedTable from a file (returns false in case of failure)
0064
0065   friend std::ostream& operator<<(std::ostream& out, G4OrderedTable& table);
0066 };
0067
0068 #endif