G4DataVector.hh

Go to the documentation of this file.
00001 //
00002 // ********************************************************************
00003 // * License and Disclaimer                                           *
00004 // *                                                                  *
00005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
00006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
00007 // * conditions of the Geant4 Software License,  included in the file *
00008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
00009 // * include a list of copyright holders.                             *
00010 // *                                                                  *
00011 // * Neither the authors of this software system, nor their employing *
00012 // * institutes,nor the agencies providing financial support for this *
00013 // * work  make  any representation or  warranty, express or implied, *
00014 // * regarding  this  software system or assume any liability for its *
00015 // * use.  Please see the license in the file  LICENSE  and URL above *
00016 // * for the full disclaimer and the limitation of liability.         *
00017 // *                                                                  *
00018 // * This  code  implementation is the result of  the  scientific and *
00019 // * technical work of the GEANT4 collaboration.                      *
00020 // * By using,  copying,  modifying or  distributing the software (or *
00021 // * any work based  on the software)  you  agree  to acknowledge its *
00022 // * use  in  resulting  scientific  publications,  and indicate your *
00023 // * acceptance of all terms of the Geant4 Software license.          *
00024 // ********************************************************************
00025 //
00026 //
00027 // $Id$
00028 //
00029 // 
00030 // ------------------------------------------------------------
00031 //      GEANT 4 class header file 
00032 // ------------------------------------------------------------
00033 //
00034 // Class Description:
00035 //
00036 //   Utility class providing similar behaviour of vector<G4double>.
00037 //   It includes additional methods for compatibility with Rogue Wave
00038 //   collection.
00039 //
00040 
00041 #ifndef G4DataVector_h
00042 #define G4DataVector_h 1
00043 
00044 #include "globals.hh"
00045 #include <vector>
00046 #include "G4ios.hh"
00047 #include <iostream>
00048 #include <fstream>
00049 
00050 class G4DataVector : public std::vector<G4double> 
00051 {
00052 
00053  public: // with description
00054 
00055   G4DataVector();
00056    // Default constructor.
00057 
00058   explicit G4DataVector(size_t cap);
00059    // Constructor given a 'capacity' defining the initial number of elements.
00060 
00061   G4DataVector(size_t cap, G4double value);
00062    // Constructor given a 'capacity' defining the initial number of elements
00063    // and initialising them to 'value'.
00064 
00065   virtual ~G4DataVector();
00066    // Empty destructor
00067 
00068   inline void insertAt(size_t, const G4double&);
00069     // Insert an element at given position
00070 
00071   inline size_t index(const G4double&);
00072     // Returns back index of the element same as given value
00073 
00074   inline G4bool contains(const G4double&) const;
00075     // Returns 'true' if it contains the element same as given value 
00076 
00077   inline G4bool remove(const G4double&);
00078     // Removes the first element same as given value  
00079 
00080   inline size_t removeAll(const G4double&);
00081     // Remove all elements same as given value  
00082 
00083   enum {T_G4DataVector = 100};
00084 
00085   G4bool Store(std::ofstream& fOut, G4bool ascii=false);
00086   G4bool Retrieve(std::ifstream& fIn, G4bool ascii=false);
00087   // To store/retrieve persistent data to/from file streams.
00088 
00089   friend std::ostream& operator<<(std::ostream&, const G4DataVector&);
00090 };
00091 
00092 #include "G4DataVector.icc"
00093 
00094 #endif

Generated on Mon May 27 17:47:59 2013 for Geant4 by  doxygen 1.4.7