G4HtmlPPReporter Class Reference

#include <G4HtmlPPReporter.hh>

Inheritance diagram for G4HtmlPPReporter:

Public Types
typedef std::vector< G4ParticlePropertyData * >	G4PPDContainer

Public Member Functions
virtual void	Clear ()
virtual G4bool	FillList (G4String name)
	G4HtmlPPReporter ()
const G4PPDContainer &	GetList () const
G4bool	operator!= (const G4VParticlePropertyReporter &right) const
G4bool	operator== (const G4VParticlePropertyReporter &right) const
virtual void	Print (const G4String &option="")
virtual	~G4HtmlPPReporter ()

Protected Attributes
G4PPDContainer	pList
G4ParticlePropertyTable *	pPropertyTable

Private Member Functions
void	GenerateIndex ()
void	GeneratePropertyTable (const G4ParticleDefinition *)
void	PrintFooter (std::ofstream &)
void	PrintHeader (std::ofstream &)
void	SparseOption (const G4String &option)

Private Attributes
G4String	baseDir
G4String	comment

Static Private Attributes
static const char *	eB = "</B>"
static const char *	eLFONT = "</FONT>"
static const char *	eSUB = "</SUB>"
static const char *	eSUP = "</SUP>"
static const char *	eSYMBOL = "</FONT>"
static const char *	eTABLE = "</TABLE>"
static const char *	eTD = "</TD>"
static const char *	eTR = "</TR>"
static const char *	sB = "<B>"
static const char *	sLFONT = "<FONT SIZE = +1>"
static const char *	sSUB = "<SUB>"
static const char *	sSUP = "<SUP>"
static const char *	sSYMBOL = "<FONT FACE = \"symbol\" >"
static const char *	sTABLE = "<TABLE WIDTH="
static const char *	sTD = "<TD>"
static const char *	sTR = "<TR>"

Detailed Description

Definition at line 44 of file G4HtmlPPReporter.hh.

Member Typedef Documentation

G4PPDContainer

typedef std::vector<G4ParticlePropertyData*> G4VParticlePropertyReporter::G4PPDContainer

inherited

Definition at line 63 of file G4VParticlePropertyReporter.hh.

Constructor & Destructor Documentation

G4HtmlPPReporter()

G4HtmlPPReporter::G4HtmlPPReporter

(

)

Definition at line 46 of file G4HtmlPPReporter.cc.

                                   :G4VParticlePropertyReporter()
{
 
}

~G4HtmlPPReporter()

G4HtmlPPReporter::~G4HtmlPPReporter ( )

virtual

Definition at line 51 of file G4HtmlPPReporter.cc.

{
}    

Member Function Documentation

Clear()

void G4VParticlePropertyReporter::Clear ( )

virtualinherited

Definition at line 85 of file G4VParticlePropertyReporter.cc.

{
  pList.clear();
}

References G4VParticlePropertyReporter::pList.

FillList()

G4bool G4VParticlePropertyReporter::FillList ( G4String  name )

virtualinherited

Definition at line 53 of file G4VParticlePropertyReporter.cc.

{
  G4ParticlePropertyData* pData = pPropertyTable->GetParticleProperty(name);
  G4bool result = false;
  if (pData != 0) {
    //the particle exists
    pList.push_back(pData);
    result = true;
  } else {
    // pointer to the particle table
    G4ParticleTable* theParticleTable = G4ParticleTable::GetParticleTable();
    G4ParticleTable::G4PTblDicIterator* theParticleIterator;
    theParticleIterator = theParticleTable->GetIterator();
    
    // loop over all particles in G4ParticleTable 
    theParticleIterator->reset();
    while( (*theParticleIterator)() ){ // Loop checking, 09.08.2015, K.Kurashige
      G4ParticleDefinition* particle = theParticleIterator->value();
      G4String type = particle->GetParticleType();
      pData =pPropertyTable->GetParticleProperty(particle);
      if ( name == "all" ) {
    pList.push_back(pData);
        result = true;
      } else if ( name == type ) {
    pList.push_back(pData);
        result = true;
      } 
    }
  }
  return result;
}

References G4ParticleTable::GetIterator(), G4ParticlePropertyTable::GetParticleProperty(), G4ParticleTable::GetParticleTable(), G4ParticleDefinition::GetParticleType(), G4InuclParticleNames::name(), G4VParticlePropertyReporter::pList, G4VParticlePropertyReporter::pPropertyTable, and theParticleIterator.

GenerateIndex()

void G4HtmlPPReporter::GenerateIndex ( )

private

Definition at line 82 of file G4HtmlPPReporter.cc.

{
  //--- open index file -----
  G4String fileName = baseDir + "index.html";
  std::ofstream outFile(fileName, std::ios::out );
  outFile.setf( std::ios:: scientific, std::ios::floatfield );
  
  // header
  PrintHeader(outFile);
  
  // comment
  outFile << "<! -- " << comment << " -- !> " << G4endl;
  outFile << G4endl;
  
  
  outFile << sTABLE << '"' << "80%" << '"' << " > " << G4endl;
  
  // Raw #1
  outFile << sTR;
  outFile << sTD << sLFONT << "Code" << eLFONT<< eTD; 
  outFile << sTD << sLFONT << "Name" << eLFONT<< eTD; 
  outFile << sTD << sLFONT << "Mass" << eLFONT << eTD;
  outFile << sTD << sLFONT << "Charge" << eLFONT << eTD;
  outFile << sTD << sLFONT << "Life Time" << eLFONT << eTD;
  outFile << sTD << sLFONT << "Anti-Particle" << eLFONT<< eTD; 
  outFile << eTR << G4endl;;
  
  // Raw #2
  outFile << sTR;
  outFile << sTD << " " << eTD; 
  outFile << sTD << " " << eTD; 
  outFile << sTD <<  " [GeV/c" << sSUP << "2" << eSUP << "]" << eTD;
  outFile << sTD << " " << eTD; 
  outFile << sTD <<  " [ns]" << eTD;
  outFile << sTD << " " << eTD; 
  outFile << eTR << G4endl;;
 
  for (size_t i=0; i< pList.size(); i++){
    if (pList[i]->GetPDGEncoding()<0) continue;
 
    outFile << sTR << G4endl;;
    // column 1  : endcoding
    outFile << sTD << pList[i]->GetPDGEncoding() << eTD << G4endl;; 
    // column 2  : name 
    G4String name = pList[i]->GetParticleName();
    
    G4String fname = name +".html";
    // exception
    if (name == "J/psi") fname = "jpsi.html";
    
    outFile << sTD;
    outFile << "<A HREF=" << '"' << fname << '"' << ">";
    outFile << name << "</A>" << eTD << G4endl;
   
    // column 3 mass
    outFile << sTD <<  pList[i]->GetPDGMass()/GeV << eTD << G4endl;
 
    // column 4 charge
    outFile << sTD <<  pList[i]->GetPDGCharge()/eplus << eTD << G4endl;
 
    // column 5 life time
    outFile << sTD <<  pList[i]->GetPDGLifeTime()/ns << eTD << G4endl;
    
    // column 6 AntiParticle
    if  ( (pList[i]->GetAntiPDGEncoding()!= 0) &&
          (pList[i]->GetAntiPDGEncoding() != pList[i]->GetPDGEncoding() ) ) {
      G4ParticleDefinition* anti_particle  = G4ParticleTable::GetParticleTable()->FindParticle( pList[i]->GetAntiPDGEncoding() ); 
      
      outFile << sTD <<  anti_particle->GetParticleName() << eTD << G4endl;;
    }
 
    // end raw
    outFile << eTR << G4endl;;
  }
  
  outFile << eTABLE << G4endl;
  
  // footer
  PrintFooter(outFile); 
  
}

References baseDir, comment, eLFONT, eplus, eSUP, eTABLE, eTD, eTR, G4ParticleTable::FindParticle(), test::fname, G4endl, G4ParticleDefinition::GetParticleName(), G4ParticleTable::GetParticleTable(), GeV, G4InuclParticleNames::name(), ns, G4VParticlePropertyReporter::pList, PrintFooter(), PrintHeader(), sLFONT, sSUP, sTABLE, sTD, and sTR.

Referenced by Print().

GeneratePropertyTable()

void G4HtmlPPReporter::GeneratePropertyTable ( const G4ParticleDefinition *  particle )

private

Definition at line 164 of file G4HtmlPPReporter.cc.

{
  if (particle->GetPDGEncoding()<0) return;
 
  G4String name = particle->GetParticleName();
  //--- open index file -----
  G4String fileName = baseDir + name + ".html";
  // exception
  if (name == "J/psi") fileName = baseDir +"jpsi.html";
  std::ofstream outFile(fileName, std::ios::out );
  outFile.setf( std::ios:: scientific, std::ios::floatfield );
  outFile << std::setprecision(7) << G4endl;
 
  PrintHeader(outFile);
   
  // particle name
  outFile << "<H2>" << name << "</H2>" << G4endl;
  outFile << "<HR>" << G4endl;
 
  // encoding, type
  outFile << sTABLE << '"' << "40%" << '"' << " > " << G4endl;
  outFile << sTR << sTD << sB << "PDG encoding" << eB << eTD;
  outFile << sTD <<  particle->GetPDGEncoding() << eTD << eTR << G4endl;
  outFile << sTR << sTD << sB << "Type" << eB << eTD;
  outFile << sTD <<  particle->GetParticleType() << eTD << eTR << G4endl;
  outFile << eTABLE << G4endl;
  outFile << "<HR>" << G4endl;
 
  // Properties  
  outFile << sTABLE << '"' << "60%" << '"' << " > " << G4endl;
  // mass
  outFile << sTR << sTD << sB << "Mass" << eB << eTD;
  outFile << sTD <<  particle->GetPDGMass()/GeV;
  outFile << " [GeV/c" << sSUP << "2" << eSUP << "]" << eTD << eTR << G4endl;
  // width
  outFile << sTR << sTD << sB << "Width" << eB << eTD;
  outFile << sTD <<  particle->GetPDGWidth()/GeV;
  outFile << " [GeV/c" << sSUP << "2" << eSUP << "]" << eTD << eTR << G4endl;
  // IJPC
  outFile << sTR << sTD << sB << "I J" << sSUP << "PC"<< eSUP << eB << eTD;
  if ( particle->GetPDGiIsospin() <0 ) {
    outFile << sTD << "    ";
  } else if ( particle->GetPDGiIsospin() == 1) {
    outFile << sTD << "1/2 ";
  } else if ( particle->GetPDGiIsospin() == 3) {
    outFile << sTD << "3/2 "; 
  } else {
    outFile << sTD << particle->GetPDGiIsospin()/2 << " ";
  }
  if ( particle->GetPDGiSpin() == 1) {
    outFile << "1/2";
  } else if ( particle->GetPDGiSpin() == 3) {
    outFile << "3/2"; 
  } else if ( particle->GetPDGiSpin() == 5) {
    outFile << "5/2"; 
  } else if ( particle->GetPDGiSpin() == 7) {
    outFile << "7/2"; 
  } else if ( particle->GetPDGiSpin() == 9) {
    outFile << "9/2"; 
  } else if ( particle->GetPDGiSpin() == 11) {
    outFile << "11/2"; 
  } else if ( particle->GetPDGiSpin() == 13) {
    outFile << "13/2"; 
  } else {
    outFile << particle->GetPDGiSpin()/2;
  }
  outFile << sSUP << sSYMBOL;
  if (particle->GetPDGiParity() == +1 ){
    outFile << "+";
  } else if (particle->GetPDGiParity() == -1 ){
    outFile << "-";
  } else {
    outFile << " ";
  }
  if (particle->GetPDGiConjugation() == +1 ){
    outFile << "+";
  } else if (particle->GetPDGiConjugation() == -1 ){
    outFile << "-";
  } else {
    outFile << " ";
  }
  outFile << eSYMBOL << eSUP;
  outFile <<  eTD << eTR << G4endl;
  // charge
  outFile << sTR << sTD << sB << "Charge" << eB << eTD;
  outFile << sTD <<  particle->GetPDGCharge()/eplus;
  outFile << eTD << eTR << G4endl;
  // Magnetic Moment
  outFile << sTR << sTD << sB << "Magnetic Moment" << eB << eTD;
  if  (particle->GetPDGMagneticMoment() != 0.0){
    outFile << sTD <<  particle->GetPDGMagneticMoment()/MeV*tesla;
    outFile << "[MeV/T]" << eTD << eTR << G4endl;
  } else {
    outFile << sTD <<  " not defined ";
    outFile << eTD << eTR << G4endl;
  }
  // life time
  outFile << sTR << sTD << sB << "Life Time" << eB << eTD;
  if ( particle->GetPDGLifeTime() >0.0 ) {
    outFile << sTD <<  particle->GetPDGLifeTime()/second;
    outFile << "[sec]" << eTD << G4endl;
  } else {
    if (particle->GetPDGStable()) {
      outFile << sTD << "stable" << eTD;
    } else if (particle->IsShortLived()) {
      outFile << sTD << "short-lived" << eTD;
    } else {
      outFile << sTD <<  "not Defined" << eTD;
    }
  }
  outFile << eTR << G4endl;
 
  outFile << eTABLE << G4endl;
  outFile << "<HR>" << G4endl;
 
  // Qurak content 
  outFile << "<H2>" << " Quark Content " << "</H2>" << G4endl;
 
  outFile << sTABLE << '"' << "60%" << '"' << " > " << G4endl;
 
  outFile << sTR;
  outFile << sTD << sB << "flavour " << eB << eTD ;
  outFile << sTD << sB << " quark " << eB << eTD; 
  outFile << sTD << sB << " anti-quark " << eB << eTD; 
  outFile << eTR;
 
  static const char* quarkName[6] = { "d", "u", "s", "c", "b", "t" };
  for (G4int flv = 0; flv <6 ; flv++ ){
    outFile << sTR;
    outFile << sTD << sB << quarkName[flv] << eB << eTD ;
    outFile << sTD << sB << particle->GetQuarkContent(flv+1) << eB << eTD ;
    outFile << sTD << sB << particle->GetAntiQuarkContent(flv+1) << eB << eTD ;
    outFile << eTR;
  }
  outFile << eTABLE << G4endl;
  outFile << "<HR>" << G4endl;
 
 // Decay Table  
  G4DecayTable* dcyTable = particle->GetDecayTable(); 
  if (dcyTable != 0) { 
    outFile << "<H2>" << " Decay Table " << "</H2>" << G4endl;
 
    outFile << sTABLE << '"' << "80%" << '"' << " > " << G4endl;
    
    outFile << sTR;
    outFile << sTD << sB << "BR" << eB << eTD ;
    outFile << sTD << sB << "kinematics" << eB << eTD; 
    outFile << eTR;
 
    for (G4int i=0; i< dcyTable->entries(); i++){
      G4VDecayChannel * channel = dcyTable->GetDecayChannel(i);
      outFile << sTR << G4endl;;
      // column 1  : BR
      outFile << sTD << channel->GetBR() << eTD;
      // column 2 : Kinematics
      outFile << sTD << channel->GetKinematicsName() << eTD;
      // column 3..  : daughters
      for (G4int j=0; j< channel->GetNumberOfDaughters(); j++){
        outFile << sTD << channel->GetDaughter(j)->GetParticleName() << eTD;
      }
      outFile << eTR << G4endl;
    }
    outFile << eTABLE << G4endl;
    outFile << "<HR>" << G4endl;
  }
  
  outFile << sB;
  outFile << "<A HREF=" << '"' <<  "index.html" << '"' << ">back to index</A>";
  outFile << eB << G4endl;
 
  PrintFooter(outFile); 
}

References baseDir, eB, G4DecayTable::entries(), eplus, eSUP, eSYMBOL, eTABLE, eTD, eTR, G4endl, G4ParticleDefinition::GetAntiQuarkContent(), G4VDecayChannel::GetBR(), G4VDecayChannel::GetDaughter(), G4DecayTable::GetDecayChannel(), G4ParticleDefinition::GetDecayTable(), G4VDecayChannel::GetKinematicsName(), G4VDecayChannel::GetNumberOfDaughters(), G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetParticleType(), G4ParticleDefinition::GetPDGCharge(), G4ParticleDefinition::GetPDGEncoding(), G4ParticleDefinition::GetPDGiConjugation(), G4ParticleDefinition::GetPDGiIsospin(), G4ParticleDefinition::GetPDGiParity(), G4ParticleDefinition::GetPDGiSpin(), G4ParticleDefinition::GetPDGLifeTime(), G4ParticleDefinition::GetPDGMagneticMoment(), G4ParticleDefinition::GetPDGMass(), G4ParticleDefinition::GetPDGStable(), G4ParticleDefinition::GetPDGWidth(), G4ParticleDefinition::GetQuarkContent(), GeV, G4ParticleDefinition::IsShortLived(), MeV, G4InuclParticleNames::name(), PrintFooter(), PrintHeader(), sB, second, sSUP, sSYMBOL, sTABLE, sTD, sTR, and tesla.

Referenced by Print().

GetList()

const G4PPDContainer & G4VParticlePropertyReporter::GetList ( ) const

inlineinherited

Definition at line 76 of file G4VParticlePropertyReporter.hh.

{return pList;}

References G4VParticlePropertyReporter::pList.

operator!=()

G4bool G4VParticlePropertyReporter::operator!= ( const G4VParticlePropertyReporter &  right ) const

inlineinherited

Definition at line 59 of file G4VParticlePropertyReporter.hh.

  {   return (this != &right);    }

operator==()

G4bool G4VParticlePropertyReporter::operator== ( const G4VParticlePropertyReporter &  right ) const

inlineinherited

Definition at line 56 of file G4VParticlePropertyReporter.hh.

  {   return (this == &right);    }

Print()

void G4HtmlPPReporter::Print ( const G4String &  option = "" )

virtual

Implements G4VParticlePropertyReporter.

Definition at line 55 of file G4HtmlPPReporter.cc.

{
  SparseOption( option );
 
  GenerateIndex();
 
  for (size_t i=0; i< pList.size(); i++){
    G4ParticleDefinition* particle  = G4ParticleTable::GetParticleTable()->FindParticle( pList[i]->GetParticleName() ); 
    GeneratePropertyTable(particle);
  }
}    

References G4ParticleTable::FindParticle(), GenerateIndex(), GeneratePropertyTable(), G4ParticleTable::GetParticleTable(), G4VParticlePropertyReporter::pList, and SparseOption().

PrintFooter()

void G4HtmlPPReporter::PrintFooter ( std::ofstream &  outFile )

private

Definition at line 352 of file G4HtmlPPReporter.cc.

{
  outFile << "<HR>" << G4endl;
  outFile << "</BODY>" << G4endl;
  outFile << "</HTML>" << G4endl;
}

References G4endl.

Referenced by GenerateIndex(), and GeneratePropertyTable().

PrintHeader()

void G4HtmlPPReporter::PrintHeader ( std::ofstream &  outFile )

private

Definition at line 337 of file G4HtmlPPReporter.cc.

{
  outFile << "<HTML>" << G4endl;
  outFile << "<HEAD>" << G4endl;
  outFile << " <META HTTP-EQUIV=" << "\"" << " Content-Type" << "\"";
  outFile << " CONTENT=" 
      << "\"" << "text/html; charset=iso-8859-1" 
      << "\"" << ">" << G4endl;
  outFile << " <TITLE>Geant4 Particle List </TITLE>" << G4endl;
  outFile << "</HEAD>" << G4endl;
  outFile << "<! -- Generated automatically by Geant4, "
      << " -- !>" << G4endl;
  outFile << "<BODY>" << G4endl;
}

References G4endl.

Referenced by GenerateIndex(), and GeneratePropertyTable().

SparseOption()

void G4HtmlPPReporter::SparseOption ( const G4String &  option )

private

Definition at line 68 of file G4HtmlPPReporter.cc.

{
  G4Tokenizer savedToken( option );
  
  // 1st option : base directory
  baseDir = savedToken();
  if (!baseDir.empty()) {
    if(baseDir.back()!='/') {
      baseDir += "/";
    }
  }
  comment =  savedToken();
}

References baseDir, and comment.

Referenced by Print().

Field Documentation

baseDir

G4String G4HtmlPPReporter::baseDir

private

Definition at line 76 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), GeneratePropertyTable(), and SparseOption().

comment

G4String G4HtmlPPReporter::comment

private

Definition at line 77 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and SparseOption().

eB

const char * G4HtmlPPReporter::eB = "</B>"

staticprivate

Definition at line 69 of file G4HtmlPPReporter.hh.

Referenced by GeneratePropertyTable().

eLFONT

const char * G4HtmlPPReporter::eLFONT = "</FONT>"

staticprivate

Definition at line 70 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex().

eSUB

const char * G4HtmlPPReporter::eSUB = "</SUB>"

staticprivate

Definition at line 73 of file G4HtmlPPReporter.hh.

eSUP

const char * G4HtmlPPReporter::eSUP = "</SUP>"

staticprivate

Definition at line 72 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

eSYMBOL

const char * G4HtmlPPReporter::eSYMBOL = "</FONT>"

staticprivate

Definition at line 71 of file G4HtmlPPReporter.hh.

Referenced by GeneratePropertyTable().

eTABLE

const char * G4HtmlPPReporter::eTABLE = "</TABLE>"

staticprivate

Definition at line 66 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

eTD

const char * G4HtmlPPReporter::eTD = "</TD>"

staticprivate

Definition at line 68 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

eTR

const char * G4HtmlPPReporter::eTR = "</TR>"

staticprivate

Definition at line 67 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

pList

G4PPDContainer G4VParticlePropertyReporter::pList

protectedinherited

Definition at line 79 of file G4VParticlePropertyReporter.hh.

Referenced by G4VParticlePropertyReporter::Clear(), G4VParticlePropertyReporter::FillList(), GenerateIndex(), G4VParticlePropertyReporter::GetList(), Print(), G4SimplePPReporter::Print(), G4TextPPReporter::Print(), and G4VParticlePropertyReporter::~G4VParticlePropertyReporter().

pPropertyTable

G4ParticlePropertyTable* G4VParticlePropertyReporter::pPropertyTable

protectedinherited

Definition at line 80 of file G4VParticlePropertyReporter.hh.

Referenced by G4VParticlePropertyReporter::FillList(), G4VParticlePropertyReporter::G4VParticlePropertyReporter(), and G4VParticlePropertyReporter::~G4VParticlePropertyReporter().

sB

const char * G4HtmlPPReporter::sB = "<B>"

staticprivate

Definition at line 69 of file G4HtmlPPReporter.hh.

Referenced by GeneratePropertyTable().

sLFONT

const char * G4HtmlPPReporter::sLFONT = "<FONT SIZE = +1>"

staticprivate

Definition at line 70 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex().

sSUB

const char * G4HtmlPPReporter::sSUB = "<SUB>"

staticprivate

Definition at line 73 of file G4HtmlPPReporter.hh.

sSUP

const char * G4HtmlPPReporter::sSUP = "<SUP>"

staticprivate

Definition at line 72 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

sSYMBOL

const char * G4HtmlPPReporter::sSYMBOL = "<FONT FACE = \"symbol\" >"

staticprivate

Definition at line 71 of file G4HtmlPPReporter.hh.

Referenced by GeneratePropertyTable().

sTABLE

const char * G4HtmlPPReporter::sTABLE = "<TABLE WIDTH="

staticprivate

Definition at line 66 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

sTD

const char * G4HtmlPPReporter::sTD = "<TD>"

staticprivate

Definition at line 68 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

sTR

const char * G4HtmlPPReporter::sTR = "<TR>"

staticprivate

Definition at line 67 of file G4HtmlPPReporter.hh.

Referenced by GenerateIndex(), and GeneratePropertyTable().

---

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

• source/particles/utils/include/G4HtmlPPReporter.hh
• source/particles/utils/src/G4HtmlPPReporter.cc