G4UnitDefinition Class Reference

#include <G4UnitsTable.hh>

Public Member Functions
	G4UnitDefinition (const G4String &name, const G4String &symbol, const G4String &category, G4double value)
	~G4UnitDefinition ()
G4int	operator== (const G4UnitDefinition &) const
G4int	operator!= (const G4UnitDefinition &) const
const G4String &	GetName () const
const G4String &	GetSymbol () const
G4double	GetValue () const
void	PrintDefinition ()
Static Public Member Functions
static void	BuildUnitsTable ()
static void	PrintUnitsTable ()
static void	ClearUnitsTable ()
static G4UnitsTable &	GetUnitsTable ()
static G4double	GetValueOf (const G4String &)
static G4String	GetCategory (const G4String &)

---

Detailed Description

Definition at line 64 of file G4UnitsTable.hh.

---

Constructor & Destructor Documentation

G4UnitDefinition::G4UnitDefinition	(	const G4String &	name,
		const G4String &	symbol,
		const G4String &	category,
		G4double	value
	)

Definition at line 59 of file G4UnitsTable.cc.

References GetName().

Referenced by BuildUnitsTable().

  : Name(name),SymbolName(symbol),Value(value)   
{
    // Does the Category objet already exist ?
    //
    size_t nbCat = theUnitsTable.size();
    size_t i = 0;
    while ((i<nbCat)&&(theUnitsTable[i]->GetName()!=category))  { i++; }
    if (i == nbCat)
      { theUnitsTable.push_back( new G4UnitsCategory(category)); }
    CategoryIndex = i;

    // Insert this Unit in the Units table
    //
    (theUnitsTable[CategoryIndex]->GetUnitsList()).push_back(this);
    
    // Update string max length for name and symbol
    //
    theUnitsTable[i]->UpdateNameMxLen((G4int)name.length());
    theUnitsTable[i]->UpdateSymbMxLen((G4int)symbol.length());
}

G4UnitDefinition::~G4UnitDefinition

(

)

Definition at line 85 of file G4UnitsTable.cc.

{
}

---

Member Function Documentation

void G4UnitDefinition::BuildUnitsTable

(

)

[static]

Definition at line 189 of file G4UnitsTable.cc.

References G4UnitDefinition(), and pascal.

Referenced by G4GDMLRead::G4GDMLRead(), GetUnitsTable(), and G4DimensionedTypeUtils::GetUnitValue().

{
 //Length
 new G4UnitDefinition(    "parsec","pc"      ,"Length",parsec); 
 new G4UnitDefinition( "kilometer","km"      ,"Length",kilometer);
 new G4UnitDefinition(     "meter","m"       ,"Length",meter);
 new G4UnitDefinition("centimeter","cm"      ,"Length",centimeter); 
 new G4UnitDefinition("millimeter","mm"      ,"Length",millimeter);
 new G4UnitDefinition("micrometer","um"      ,"Length",micrometer);
 new G4UnitDefinition( "nanometer","nm"      ,"Length",nanometer);
 new G4UnitDefinition(  "angstrom","Ang"     ,"Length",angstrom);    
 new G4UnitDefinition(     "fermi","fm"      ,"Length",fermi);
 
 //Surface
 new G4UnitDefinition( "kilometer2","km2"    ,"Surface",kilometer2);
 new G4UnitDefinition(     "meter2","m2"     ,"Surface",meter2);
 new G4UnitDefinition("centimeter2","cm2"    ,"Surface",centimeter2); 
 new G4UnitDefinition("millimeter2","mm2"    ,"Surface",millimeter2);
 new G4UnitDefinition(       "barn","barn"   ,"Surface",barn);
 new G4UnitDefinition(  "millibarn","mbarn"  ,"Surface",millibarn);   
 new G4UnitDefinition(  "microbarn","mubarn" ,"Surface",microbarn);
 new G4UnitDefinition(   "nanobarn","nbarn"  ,"Surface",nanobarn);
 new G4UnitDefinition(   "picobarn","pbarn"  ,"Surface",picobarn);
 
 //Volume
 new G4UnitDefinition( "kilometer3","km3"    ,"Volume",kilometer3);
 new G4UnitDefinition(     "meter3","m3"     ,"Volume",meter3);
 new G4UnitDefinition("centimeter3","cm3"    ,"Volume",centimeter3); 
 new G4UnitDefinition("millimeter3","mm3"    ,"Volume",millimeter3);

 //Angle
 new G4UnitDefinition(     "radian","rad"    ,"Angle",radian);
 new G4UnitDefinition("milliradian","mrad"   ,"Angle",milliradian); 
 new G4UnitDefinition(     "degree","deg"    ,"Angle",degree);
 
 //Solid angle
 new G4UnitDefinition(  "steradian","sr"     ,"Solid angle",steradian);
 new G4UnitDefinition("millisteradian","msr" ,"Solid angle",steradian*0.001);
   
 //Time
 new G4UnitDefinition(     "second","s"      ,"Time",second);
 new G4UnitDefinition("millisecond","ms"     ,"Time",millisecond);
 new G4UnitDefinition("microsecond","mus"    ,"Time",microsecond);
 new G4UnitDefinition( "nanosecond","ns"     ,"Time",nanosecond);
 new G4UnitDefinition( "picosecond","ps"     ,"Time",picosecond);
 
 //Frequency
 new G4UnitDefinition(    "hertz","Hz"       ,"Frequency",hertz);
 new G4UnitDefinition("kilohertz","kHz"      ,"Frequency",kilohertz);
 new G4UnitDefinition("megahertz","MHz"      ,"Frequency",megahertz);
 
 //Electric charge
 new G4UnitDefinition(  "eplus","e+"         ,"Electric charge",eplus);
 new G4UnitDefinition("coulomb","C"          ,"Electric charge",coulomb); 
 
 //Energy
 new G4UnitDefinition(    "electronvolt","eV" ,"Energy",electronvolt);
 new G4UnitDefinition("kiloelectronvolt","keV","Energy",kiloelectronvolt);
 new G4UnitDefinition("megaelectronvolt","MeV","Energy",megaelectronvolt);
 new G4UnitDefinition("gigaelectronvolt","GeV","Energy",gigaelectronvolt);
 new G4UnitDefinition("teraelectronvolt","TeV","Energy",teraelectronvolt);
 new G4UnitDefinition("petaelectronvolt","PeV","Energy",petaelectronvolt);
 new G4UnitDefinition(           "joule","J"  ,"Energy",joule);
 
 // Energy/Length
 new G4UnitDefinition( "GeV/cm", "GeV/cm","Energy/Length", GeV/cm);
 new G4UnitDefinition( "MeV/cm", "MeV/cm","Energy/Length", MeV/cm);
 new G4UnitDefinition( "keV/cm", "keV/cm","Energy/Length", keV/cm);
 new G4UnitDefinition(  "eV/cm",  "eV/cm","Energy/Length",  eV/cm); 
  
 //Mass
 new G4UnitDefinition("milligram","mg","Mass",milligram);
 new G4UnitDefinition(     "gram","g" ,"Mass",gram);
 new G4UnitDefinition( "kilogram","kg","Mass",kilogram);
 
 //Volumic Mass
 new G4UnitDefinition( "g/cm3", "g/cm3","Volumic Mass", g/cm3);
 new G4UnitDefinition("mg/cm3","mg/cm3","Volumic Mass",mg/cm3);
 new G4UnitDefinition("kg/m3", "kg/m3", "Volumic Mass",kg/m3);
 
 // Mass/Surface
 new G4UnitDefinition(  "g/cm2",  "g/cm2","Mass/Surface",  g/cm2);
 new G4UnitDefinition( "mg/cm2", "mg/cm2","Mass/Surface", mg/cm2);
 new G4UnitDefinition( "kg/cm2", "kg/cm2","Mass/Surface", kg/cm2);
   
 // Surface/Mass
 new G4UnitDefinition( "cm2/g", "cm2/g","Surface/Mass", cm2/g);
 
 // Energy.Surface/Mass
 new G4UnitDefinition( "eV*cm2/g", " eV*cm2/g","Energy*Surface/Mass", eV*cm2/g);
 new G4UnitDefinition("keV*cm2/g", "keV*cm2/g","Energy*Surface/Mass",keV*cm2/g);
 new G4UnitDefinition("MeV*cm2/g", "MeV*cm2/g","Energy*Surface/Mass",MeV*cm2/g);
 new G4UnitDefinition("GeV*cm2/g", "GeV*cm2/g","Energy*Surface/Mass",GeV*cm2/g);
     
 //Power
 new G4UnitDefinition("watt","W","Power",watt);
 
 //Force
 new G4UnitDefinition("newton","N","Force",newton);
 
 //Pressure
 new G4UnitDefinition(    "pascal","Pa" ,"Pressure",pascal);
 new G4UnitDefinition(       "bar","bar","Pressure",bar); 
 new G4UnitDefinition("atmosphere","atm","Pressure",atmosphere);
 
 //Electric current
 new G4UnitDefinition(     "ampere","A"  ,"Electric current",ampere);
 new G4UnitDefinition("milliampere","mA" ,"Electric current",milliampere);
 new G4UnitDefinition("microampere","muA","Electric current",microampere);
 new G4UnitDefinition( "nanoampere","nA" ,"Electric current",nanoampere);   
 
 //Electric potential
 new G4UnitDefinition(    "volt","V" ,"Electric potential",volt); 
 new G4UnitDefinition("kilovolt","kV","Electric potential",kilovolt);
 new G4UnitDefinition("megavolt","MV","Electric potential",megavolt);
 
 //Electric field
 new G4UnitDefinition(  "volt/m","V/m","Electric field",volt/m);
   
 //Magnetic flux
 new G4UnitDefinition("weber","Wb","Magnetic flux",weber);
 
 //Magnetic flux density
 new G4UnitDefinition(    "tesla","T" ,"Magnetic flux density",tesla);
 new G4UnitDefinition("kilogauss","kG","Magnetic flux density",kilogauss);
 new G4UnitDefinition(    "gauss","G" ,"Magnetic flux density",gauss);
 
 //Temperature
 new G4UnitDefinition("kelvin","K","Temperature",kelvin);
 
 //Amount of substance
 new G4UnitDefinition("mole","mol","Amount of substance",mole);
 
 //Activity
 new G4UnitDefinition("becquerel","Bq","Activity",becquerel);
 new G4UnitDefinition(    "curie","Ci","Activity",curie);
 
 //Dose
 new G4UnitDefinition("gray","Gy","Dose",gray);                          
}

void G4UnitDefinition::ClearUnitsTable

(

)

[static]

Definition at line 343 of file G4UnitsTable.cc.

Referenced by G4RunManagerKernel::~G4RunManagerKernel().

{
  for (size_t i=0;i<theUnitsTable.size();i++)
  {
    delete theUnitsTable[i];
  }
  theUnitsTable.clear();
}

G4String G4UnitDefinition::GetCategory

(

const G4String &

)

[static]

Definition at line 156 of file G4UnitsTable.cc.

References G4Exception(), GetName(), GetUnitsTable(), and JustWarning.

Referenced by G4UIcommand::CategoryOf(), G4VPrimitiveScorer::CheckAndSetUnit(), and G4AttCheck::Standard().

{
  G4String name,symbol;
  for (size_t i=0;i<(GetUnitsTable()).size();i++)
     {
       G4UnitsContainer& units = theUnitsTable[i]->GetUnitsList();
       for (size_t j=0;j<units.size();j++)
          {
            name=units[j]->GetName(); symbol=units[j]->GetSymbol();
            if(str==name||str==symbol) 
              { return theUnitsTable[i]->GetName(); }
          }
     }
  std::ostringstream message;
  message << "The unit '" << str << "' does not exist in the Units Table.";
  G4Exception("G4UnitDefinition::GetCategory()", "InvalidUnit",
              JustWarning, message, "Returning Value = 0.");
  name = "None";     
  return name;             
}

const G4String & G4UnitDefinition::GetName

(

)

const [inline]

Definition at line 39 of file G4UnitsTable.icc.

Referenced by G4UnitDefinition(), GetCategory(), GetValueOf(), and G4DimensionedTypeUtils::HasName::operator()().

{
  return Name;
}

const G4String & G4UnitDefinition::GetSymbol

(

)

const [inline]

Definition at line 45 of file G4UnitsTable.icc.

Referenced by G4DimensionedTypeUtils::HasName::operator()().

{
  return SymbolName;
}

G4UnitsTable & G4UnitDefinition::GetUnitsTable

(

)

[static]

Definition at line 126 of file G4UnitsTable.cc.

References BuildUnitsTable().

Referenced by G4AttCheck::G4AttCheck(), G4BestUnit::G4BestUnit(), GetCategory(), G4DimensionedTypeUtils::GetUnitValue(), GetValueOf(), operator<<(), and G4UIcommand::UnitsList().

{
  if(theUnitsTable.size()==0)  { BuildUnitsTable(); }
  return theUnitsTable;
}

G4double G4UnitDefinition::GetValue

(

)

const [inline]

Definition at line 51 of file G4UnitsTable.icc.

{
  return Value;
}

G4double G4UnitDefinition::GetValueOf

(

const G4String &

)

[static]

Definition at line 134 of file G4UnitsTable.cc.

References G4Exception(), GetName(), GetUnitsTable(), and JustWarning.

Referenced by G4VPrimitiveScorer::CheckAndSetUnit(), G4ScoreQuantityMessenger::FParticleWithEnergyCommand(), G4tgrUtils::GetDouble(), G4VAnalysisManager::GetUnitValue(), G4VisCommandsViewerSet::SetNewValue(), G4AdjointSimMessenger::SetNewValue(), G4AttCheck::Standard(), and G4UIcommand::ValueOf().

{
  G4String name,symbol;
  for (size_t i=0;i<(GetUnitsTable()).size();i++)
     {
       G4UnitsContainer& units = theUnitsTable[i]->GetUnitsList();
       for (size_t j=0;j<units.size();j++)
          {
            name=units[j]->GetName(); symbol=units[j]->GetSymbol();
            if(str==name||str==symbol) 
              { return units[j]->GetValue(); }
          }
     }
  std::ostringstream message;
  message << "The unit '" << str << "' does not exist in the Units Table.";
  G4Exception("G4UnitDefinition::GetValueOf()", "InvalidUnit",
              JustWarning, message, "Returning Value = 0.");
  return 0.;             
}

G4int G4UnitDefinition::operator!=

(

const G4UnitDefinition &

)

const

Definition at line 119 of file G4UnitsTable.cc.

{
  return (this != (G4UnitDefinition *) &right);
}

G4int G4UnitDefinition::operator==

(

const G4UnitDefinition &

)

const

Definition at line 112 of file G4UnitsTable.cc.

{
  return (this == (G4UnitDefinition *) &right);
}

void G4UnitDefinition::PrintDefinition

(

)

Definition at line 179 of file G4UnitsTable.cc.

References G4cout, and G4endl.

{
  G4int nameL = theUnitsTable[CategoryIndex]->GetNameMxLen();
  G4int symbL = theUnitsTable[CategoryIndex]->GetSymbMxLen();
  G4cout << std::setw(nameL) << Name << " (" 
         << std::setw(symbL) << SymbolName << ") = " << Value << G4endl;
}

void G4UnitDefinition::PrintUnitsTable

(

)

[static]

Definition at line 332 of file G4UnitsTable.cc.

References G4cout.

Referenced by G4UnitsMessenger::SetNewValue().

{
  G4cout << "\n          ----- The Table of Units ----- \n";
  for(size_t i=0;i<theUnitsTable.size();i++)
  {
    theUnitsTable[i]->PrintCategory();
  }
}

---

The documentation for this class was generated from the following files:

• G4UnitsTable.hh
• G4UnitsTable.icc
• G4UnitsTable.cc

---