Import Geant4 1.0.0 source tree

source/materials/include/G4MaterialPropertiesTable.hh

@@ -1,12 +1,12 @@
 // This code implementation is the intellectual property of
-// the RD44 GEANT4 collaboration.
+// the GEANT4 collaboration.
 //
 // By copying, distributing or modifying the Program (or any work
 // based on the Program) you indicate your acceptance of this statement,
 // and all its terms.
 //
-// $Id: G4MaterialPropertiesTable.hh,v 1.1 1999/01/07 16:09:41 gunter Exp $
-// GEANT4 tag $Name: geant4-00-01 $
+// $Id: G4MaterialPropertiesTable.hh,v 1.7 1999/11/16 08:31:48 gcosmo Exp $
+// GEANT4 tag $Name: geant4-01-00 $
 //
 // 
 ////////////////////////////////////////////////////////////////////////
@@ -19,7 +19,10 @@
 // Version:     1.0
 // Created:     1996-02-08
 // Author:      Juliet Armstrong
-// Updated:     1997-03-25 by Peter Gumplinger
+// Updated:     1999-11-05 Migration from G4RWTPtrHashDictionary to STL
+//                         by John Allison
+//              1999-10-29 add method and class descriptors
+//              1997-03-25 by Peter Gumplinger
 //              > cosmetics (only)
 // mail:        gum@triumf.ca
 //
@@ -33,14 +36,16 @@
 /////////////
 
 #include <math.h>
-#include <rw/tphdict.h>
-#include <rw/cstring.h>
+#include "g4std/map"
 #include "globals.hh"
 #include "G4MaterialPropertyVector.hh"
 
-#define RefractionIndex "RINDEX"
+// Class Description:
+// An Material properties table is a hash table, with key = property
+// name, and value = G4MaterialPropertyVector.
+// Class Description - End:
 
-// unsigned hashString(const G4String &str);
+#define RefractionIndex "RINDEX"
 
 /////////////////////
 // Class Definition
@@ -48,12 +53,12 @@
 
 class G4MaterialPropertiesTable {
 
-public:
-
 	//////////////
         // Operators
         //////////////
 
+private:
+
 	G4MaterialPropertiesTable&
 		operator =(const G4MaterialPropertiesTable &right);
 		
@@ -61,10 +66,16 @@ public:
 	// Constructor
 	////////////////
 
+public: // Without description
+
 	G4MaterialPropertiesTable(); 
-		  
+	
+private:
+
 	G4MaterialPropertiesTable(const G4MaterialPropertiesTable &right);
 
+public: // Without description
+
 	///////////////
 	// Destructor
 	///////////////
@@ -75,23 +86,33 @@ public:
 	// Methods
 	////////////
 
+public: // With description
+
 	void AddProperty(char     *key,
 		         G4double *PhotonMomenta,
 		         G4double *PropertyValues,
 		         G4int     NumEntries);
+        // Add a new property to the table by giving a key-name and the
+        // arrays x and y of size NumEntries.
 
 	void AddProperty(char *key, G4MaterialPropertyVector *opv);
+        // Add a new property to the table by giving a key-name and an
+        // already constructed G4MaterialPropertyVector.
 
 	void RemoveProperty(char *key);
+        // Remove a property from the table.
 
-	G4MaterialPropertyVector* GetProperty(char *key); 
+	G4MaterialPropertyVector* GetProperty(char *key);
+        // Get the property from the table corresponding to the key-name.
 
 	void AddEntry(char *key, G4double aPhotonMomentum,
                                  G4double  aPropertyValue);
+        // Add a new entry (pair of numbers) to the table for a given key.
 
 	void RemoveEntry(char *key, G4double  aPhotonMomentum);
+        // Remove an entry from the table for a given key and x-value.
 
-	void DumpTable();	
+	void DumpTable();
 
 private:
 
@@ -99,9 +120,9 @@ private:
 	// Private Data members
 	/////////////////////////
 
-	RWTPtrHashDictionary<G4String, G4MaterialPropertyVector> MPT;  
-	RWTPtrHashDictionaryIterator<G4String, G4MaterialPropertyVector> 
-						MPTiterator; 
+	G4std::map<G4String, G4MaterialPropertyVector*, less<G4String> > MPT;
+	typedef G4std::map<G4String, G4MaterialPropertyVector*,
+	  less<G4String> >::iterator MPTiterator;
 };
 
 #endif /* G4MaterialPropertiesTable_h */