#include <G4HepRepFileXMLWriter.hh>

Public Member Functions
void	addAttDef (const char name, const char desc, const char type, const char extra)

void	addAttValue (const char *name, bool value)

void	addAttValue (const char name, const char value)

void	addAttValue (const char *name, double value)

void	addAttValue (const char *name, double value1, double value2, double value3)

void	addAttValue (const char *name, int value)

void	addInstance ()

void	addPoint (double x, double y, double z)

void	addPrimitive ()

void	addType (const char *name, int newTypeDepth)

void	close ()

void	endTypes ()

	G4HepRepFileXMLWriter ()

void	open (const char *filespec)

Data Fields
bool	inInstance [50]

bool	inType [50]

bool	isOpen

char *	prevTypeName [50]

int	typeDepth

Private Member Functions
void	endInstance ()

void	endPoint ()

void	endPrimitive ()

void	endType ()

void	indent ()

void	init ()

Private Attributes
std::ofstream	fout

bool	inPoint

bool	inPrimitive

Detailed Description

Definition at line 50 of file G4HepRepFileXMLWriter.hh.

Constructor & Destructor Documentation

◆ G4HepRepFileXMLWriter()

G4HepRepFileXMLWriter::G4HepRepFileXMLWriter ( )

Definition at line 47 of file G4HepRepFileXMLWriter.cc.

{
  isOpen = false;
  init();
}

References init(), and isOpen.

Member Function Documentation

◆ addAttDef()

void G4HepRepFileXMLWriter::addAttDef	(	const char *	name,
		const char *	desc,
		const char *	type,
		const char *	extra
	)

Definition at line 221 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    indent();
    fout << "  <heprep:attdef extra=\"" << extra << "\" name=\"" << name
         << "\" type=\"" << type << "\"" << G4endl;
    indent();
    fout << "  desc=\"" << desc << "\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttDef No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

Referenced by G4HepRepFileSceneHandler::AddCompound(), and G4HepRepFileSceneHandler::CheckFileOpen().

◆ addAttValue() [1/5]

void G4HepRepFileXMLWriter::addAttValue	(	const char *	name,
		bool	value
	)

Definition at line 299 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    indent();
    fout << "  <heprep:attvalue showLabel=\"NONE\" name=\"" << name << "\""
         << G4endl;
    indent();
    if(value)
      fout << "    value=\"True\"/>" << G4endl;
    else
      fout << "    value=\"False\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttValue No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

◆ addAttValue() [2/5]

void G4HepRepFileXMLWriter::addAttValue	(	const char *	name,
		const char *	value
	)

Definition at line 242 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    indent();
    fout << "  <heprep:attvalue showLabel=\"NONE\" name=\"" << name << "\""
         << G4endl;
    indent();
    fout << "    value=\"" << value << "\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttValue No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddHepRepInstance(), G4HepRepFileSceneHandler::AddPrimitive(), G4HepRepFileSceneHandler::AddSolid(), G4HepRepFileSceneHandler::CheckFileOpen(), G4HepRepFileSceneHandler::InitHit(), and G4HepRepFileSceneHandler::InitTrajectory().

◆ addAttValue() [3/5]

void G4HepRepFileXMLWriter::addAttValue	(	const char *	name,
		double	value
	)

Definition at line 261 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    indent();
    fout << "  <heprep:attvalue showLabel=\"NONE\" name=\"" << name << "\""
         << G4endl;
    indent();
    fout << "    value=\"" << value << "\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttValue No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

◆ addAttValue() [4/5]

void G4HepRepFileXMLWriter::addAttValue	(	const char *	name,
		double	value1,
		double	value2,
		double	value3
	)

Definition at line 321 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    int redness   = int(value1 * 255.);
    int greenness = int(value2 * 255.);
    int blueness  = int(value3 * 255.);
    indent();
    fout << "  <heprep:attvalue showLabel=\"NONE\" name=\"" << name << "\""
         << G4endl;
    indent();
    fout << "    value=\"" << redness << "," << greenness << "," << blueness
         << "\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttValue No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

◆ addAttValue() [5/5]

void G4HepRepFileXMLWriter::addAttValue	(	const char *	name,
		int	value
	)

Definition at line 280 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    indent();
    fout << "  <heprep:attvalue showLabel=\"NONE\" name=\"" << name << "\""
         << G4endl;
    indent();
    fout << "    value=\"" << value << "\"/>" << G4endl;
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addAttValue No file is currently open"
           << G4endl;
#endif
  }
}

References fout, G4cout, G4endl, indent(), and G4InuclParticleNames::name().

◆ addInstance()

void G4HepRepFileXMLWriter::addInstance ( )

Definition at line 124 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    if(inType[typeDepth])
    {
      endInstance();
      inInstance[typeDepth] = true;
      indent();
      fout << "<heprep:instance>" << G4endl;
    }
    else
    {
#ifdef G4HEPREPFILEDEBUG
      G4cout
        << "G4HepRepFileXMLWriter:addInstance No HepRep Type is currently open"
        << G4endl;
#endif
    }
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addInstance No file is currently open"
           << G4endl;
#endif
  }
}

References endInstance(), fout, G4cout, G4endl, indent(), inInstance, inType, and typeDepth.

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddHepRepInstance(), addType(), G4HepRepFileSceneHandler::InitHit(), and G4HepRepFileSceneHandler::InitTrajectory().

◆ addPoint()

void G4HepRepFileXMLWriter::addPoint	(	double	x,
		double	y,
		double	z
	)

Definition at line 182 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    if(inPrimitive)
    {
      endPoint();
      inPoint = true;
      indent();
 
      // Include scale and center values
      G4HepRepMessenger* messenger = G4HepRepMessenger::GetInstance();
      G4double scale               = messenger->getScale();
      G4ThreeVector center         = messenger->getCenter();
      G4double xNew                = scale * (x - center.x());
      G4double yNew                = scale * (y - center.y());
      G4double zNew                = scale * (z - center.z());
 
      fout << "<heprep:point x=\"" << xNew << "\" y=\"" << yNew << "\" z=\""
           << zNew << "\">" << G4endl;
    }
    else
    {
#ifdef G4HEPREPFILEDEBUG
      G4cout << "G4HepRepFileXMLWriter:addPoint No HepRep Primitive is "
                "currently open"
             << G4endl;
#endif
    }
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addPoint No file is currently open"
           << G4endl;
#endif
  }
}

References endPoint(), fout, G4cout, G4endl, G4HepRepMessenger::getCenter(), G4HepRepMessenger::GetInstance(), G4HepRepMessenger::getScale(), indent(), inPoint, inPrimitive, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddPrimitive(), and G4HepRepFileSceneHandler::AddSolid().

◆ addPrimitive()

void G4HepRepFileXMLWriter::addPrimitive ( )

Definition at line 153 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    if(inInstance[typeDepth])
    {
      endPrimitive();
      inPrimitive = true;
      indent();
      fout << "<heprep:primitive>" << G4endl;
    }
    else
    {
#ifdef G4HEPREPFILEDEBUG
      G4cout << "G4HepRepFileXMLWriter:addPrimitive No HepRep Instance is "
                "currently open"
             << G4endl;
#endif
    }
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addPrimitive No file is currently open"
           << G4endl;
#endif
  }
}

References endPrimitive(), fout, G4cout, G4endl, indent(), inInstance, inPrimitive, and typeDepth.

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddPrimitive(), and G4HepRepFileSceneHandler::AddSolid().

◆ addType()

void G4HepRepFileXMLWriter::addType	(	const char *	name,
		int	newTypeDepth
	)

Definition at line 71 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    // Flatten structure if it exceeds maximum allowed typeDepth of 49.
    if(newTypeDepth > 49)
      newTypeDepth = 49;
 
    if(newTypeDepth < 0)
      newTypeDepth = 0;
 
    // Insert any layers that are missing from the hierarchy (protects against
    // callers that skip from, say, layer 1 to layer 3 with no layer 2).
    while(typeDepth < (newTypeDepth - 1))
    {
      addType("Layer Inserted by G4HepRepFileXMLWriter", typeDepth + 1);
      addInstance();
    }
 
    // If moving closer to the root, close previously open types.
    while(newTypeDepth < typeDepth)
      endType();
 
    // Close any remaining primitives of the current instance.
    endPrimitive();
 
    // If this is a new type name for the current depth, declare the
    // new Type.  Otherwise, it is just another Instance of the current Type.
    if(strcmp(name, prevTypeName[newTypeDepth]) != 0)
    {
      if(inType[newTypeDepth])
        endType();
 
      prevTypeName[newTypeDepth] = new char[strlen(name) + 1];
      strcpy(prevTypeName[newTypeDepth], name);
 
      inType[newTypeDepth] = true;
      indent();
      fout << "<heprep:type version=\"null\" name=\"" << name << "\">"
           << G4endl;
 
      typeDepth = newTypeDepth;
    }
  }
  else
  {
#ifdef G4HEPREPFILEDEBUG
    G4cout << "G4HepRepFileXMLWriter:addType No file is currently open."
           << G4endl;
#endif
  }
}

References addInstance(), addType(), endPrimitive(), endType(), fout, G4cout, G4endl, indent(), inType, G4InuclParticleNames::name(), prevTypeName, and typeDepth.

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddHepRepInstance(), and addType().

◆ close()

void G4HepRepFileXMLWriter::close ( )

Definition at line 372 of file G4HepRepFileXMLWriter.cc.

{
  // Close any remaining open Types
  endTypes();
 
  if(fout.good())
  {
    fout << "</heprep:heprep>" << G4endl;
    fout.close();
    isOpen = false;
  }
  else
  {
    G4cout << "G4HepRepFileXMLWriter:close No file is currently open" << G4endl;
  }
}

References endTypes(), fout, G4cout, G4endl, and isOpen.

Referenced by open(), and G4HepRepFileViewer::ShowView().

◆ endInstance()

void G4HepRepFileXMLWriter::endInstance ( )

private

Definition at line 408 of file G4HepRepFileXMLWriter.cc.

{
  if(inInstance[typeDepth])
  {
    endPrimitive();
    indent();
    fout << "</heprep:instance>" << G4endl;
    inInstance[typeDepth] = false;
  }
}

References endPrimitive(), fout, G4endl, indent(), inInstance, and typeDepth.

Referenced by addInstance(), and endType().

◆ endPoint()

void G4HepRepFileXMLWriter::endPoint ( )

private

Definition at line 430 of file G4HepRepFileXMLWriter.cc.

{
  if(inPoint)
  {
    indent();
    fout << "</heprep:point>" << G4endl;
    inPoint = false;
  }
}

References fout, G4endl, indent(), and inPoint.

Referenced by addPoint(), and endPrimitive().

◆ endPrimitive()

void G4HepRepFileXMLWriter::endPrimitive ( )

private

Definition at line 419 of file G4HepRepFileXMLWriter.cc.

{
  if(inPrimitive)
  {
    endPoint();
    indent();
    fout << "</heprep:primitive>" << G4endl;
    inPrimitive = false;
  }
}

References endPoint(), fout, G4endl, indent(), and inPrimitive.

Referenced by addPrimitive(), addType(), and endInstance().

◆ endType()

void G4HepRepFileXMLWriter::endType ( )

private

Definition at line 396 of file G4HepRepFileXMLWriter.cc.

{
  endInstance();
  indent();
  fout << "</heprep:type>" << G4endl;
  inType[typeDepth] = false;
  delete[] prevTypeName[typeDepth];
  prevTypeName[typeDepth] = new char[1];
  strcpy(prevTypeName[typeDepth], "");
  typeDepth--;
}

References endInstance(), fout, G4endl, indent(), inType, prevTypeName, and typeDepth.

Referenced by addType(), and endTypes().

◆ endTypes()

void G4HepRepFileXMLWriter::endTypes ( )

Definition at line 389 of file G4HepRepFileXMLWriter.cc.

{
  // Close any remaining open Types
  while(typeDepth > -1)
    endType();
}

References endType(), and typeDepth.

Referenced by close().

◆ indent()

void G4HepRepFileXMLWriter::indent ( )

private

Definition at line 440 of file G4HepRepFileXMLWriter.cc.

{
  if(fout.good())
  {
    int i = 0;
    while(inType[i] && i < 12)
    {
      fout << "  ";
      if(inInstance[i])
        fout << "  ";
      i++;
    }
 
    if(inPrimitive)
      fout << "  ";
    if(inPoint)
      fout << "  ";
  }
}

References fout, inInstance, inPoint, inPrimitive, and inType.

Referenced by addAttDef(), addAttValue(), addInstance(), addPoint(), addPrimitive(), addType(), endInstance(), endPoint(), endPrimitive(), and endType().

◆ init()

void G4HepRepFileXMLWriter::init ( )

private

Definition at line 53 of file G4HepRepFileXMLWriter.cc.

{
  typeDepth = -1;
 
  int i = -1;
  while(i++ < 49)
  {
    prevTypeName[i] = new char[1];
    strcpy(prevTypeName[i], "");
 
    inType[i]     = false;
    inInstance[i] = false;
  }
 
  inPrimitive = false;
  inPoint     = false;
}

References inInstance, inPoint, inPrimitive, inType, prevTypeName, and typeDepth.

Referenced by demo.App::__init__(), testem0.App::__init__(), Lesson1.App::__init__(), ExN03.App::__init__(), G4HepRepFileXMLWriter(), and open().

◆ open()

void G4HepRepFileXMLWriter::open ( const char * filespec )

Definition at line 345 of file G4HepRepFileXMLWriter.cc.

{
  if(isOpen)
    close();
 
  fout.open(fileSpec);
 
  if(fout.good())
  {
    fout << "<?xml version=\"1.0\" ?>" << G4endl;
    fout << "<heprep:heprep "
            "xmlns:heprep=\"http://www.slac.stanford.edu/~perl/heprep/\""
         << G4endl;
    fout << "  xmlns:xsi=\"http://www.w3.org/1999/XMLSchema-instance\" "
            "xsi:schemaLocation=\"HepRep.xsd\">"
         << G4endl;
 
    isOpen = true;
    init();
  }
  else
  {
    G4cout << "G4HepRepFileXMLWriter:open Unable to write to file " << fileSpec
           << G4endl;
  }
}

References close(), fout, G4cout, G4endl, init(), and isOpen.

Referenced by G4HepRepFileSceneHandler::CheckFileOpen().

Field Documentation

◆ fout

std::ofstream G4HepRepFileXMLWriter::fout

private

Definition at line 86 of file G4HepRepFileXMLWriter.hh.

Referenced by addAttDef(), addAttValue(), addInstance(), addPoint(), addPrimitive(), addType(), close(), endInstance(), endPoint(), endPrimitive(), endType(), indent(), and open().

◆ inInstance

bool G4HepRepFileXMLWriter::inInstance[50]

Definition at line 82 of file G4HepRepFileXMLWriter.hh.

Referenced by addInstance(), addPrimitive(), endInstance(), indent(), and init().

◆ inPoint

bool G4HepRepFileXMLWriter::inPoint

private

Definition at line 91 of file G4HepRepFileXMLWriter.hh.

Referenced by addPoint(), endPoint(), indent(), and init().

◆ inPrimitive

bool G4HepRepFileXMLWriter::inPrimitive

private

Definition at line 90 of file G4HepRepFileXMLWriter.hh.

Referenced by addPoint(), addPrimitive(), endPrimitive(), indent(), and init().

◆ inType

bool G4HepRepFileXMLWriter::inType[50]

Definition at line 81 of file G4HepRepFileXMLWriter.hh.

Referenced by addInstance(), addType(), endType(), indent(), and init().

◆ isOpen

bool G4HepRepFileXMLWriter::isOpen

Definition at line 79 of file G4HepRepFileXMLWriter.hh.

Referenced by G4HepRepFileSceneHandler::CheckFileOpen(), close(), G4HepRepFileXMLWriter(), open(), and G4HepRepFileViewer::ShowView().

◆ prevTypeName

char* G4HepRepFileXMLWriter::prevTypeName[50]

Definition at line 83 of file G4HepRepFileXMLWriter.hh.

Referenced by G4HepRepFileSceneHandler::AddCompound(), G4HepRepFileSceneHandler::AddHepRepInstance(), addType(), endType(), and init().

◆ typeDepth

int G4HepRepFileXMLWriter::typeDepth

Definition at line 80 of file G4HepRepFileXMLWriter.hh.

Referenced by G4HepRepFileSceneHandler::AddHepRepInstance(), addInstance(), addPrimitive(), addType(), endInstance(), endType(), endTypes(), and init().

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

source/visualization/HepRep/include/G4HepRepFileXMLWriter.hh
source/visualization/HepRep/src/G4HepRepFileXMLWriter.cc

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4HepRepFileXMLWriter()

Member Function Documentation

◆ addAttDef()

◆ addAttValue() [1/5]

◆ addAttValue() [2/5]

◆ addAttValue() [3/5]

◆ addAttValue() [4/5]

◆ addAttValue() [5/5]

◆ addInstance()

◆ addPoint()

◆ addPrimitive()

◆ addType()

◆ close()

◆ endInstance()

◆ endPoint()

◆ endPrimitive()

◆ endType()

◆ endTypes()

◆ indent()

◆ init()

◆ open()

Field Documentation

◆ fout

◆ inInstance

◆ inPoint

◆ inPrimitive

◆ inType

◆ isOpen

◆ prevTypeName

◆ typeDepth