G4GDMLWriteDefine Class Reference

#include <G4GDMLWriteDefine.hh>

Inheritance diagram for G4GDMLWriteDefine:

Public Member Functions
void	AddAuxiliary (G4GDMLAuxStructType myaux)
virtual void	AddExtension (xercesc::DOMElement *, const G4LogicalVolume *const)
void	AddModule (const G4int depth)
void	AddModule (const G4VPhysicalVolume *const topVol)
void	AddPosition (const G4String &name, const G4ThreeVector &pos)
virtual void	DefineWrite (xercesc::DOMElement *)
virtual void	ExtensionWrite (xercesc::DOMElement *)
void	FirstpositionWrite (xercesc::DOMElement *element, const G4String &name, const G4ThreeVector &pos)
void	FirstrotationWrite (xercesc::DOMElement *element, const G4String &name, const G4ThreeVector &rot)
G4String	GenerateName (const G4String &, const void *const)
G4ThreeVector	GetAngles (const G4RotationMatrix &)
virtual void	MaterialsWrite (xercesc::DOMElement *)=0
void	PositionWrite (xercesc::DOMElement *element, const G4String &name, const G4ThreeVector &pos)
void	RotationWrite (xercesc::DOMElement *element, const G4String &name, const G4ThreeVector &rot)
void	ScaleWrite (xercesc::DOMElement *element, const G4String &name, const G4ThreeVector &scl)
void	SetOutputFileOverwrite (G4bool flag)
virtual void	SetupWrite (xercesc::DOMElement *, const G4LogicalVolume *const)=0
virtual void	SolidsWrite (xercesc::DOMElement *)=0
virtual void	StructureWrite (xercesc::DOMElement *)=0
virtual void	SurfacesWrite ()=0
virtual G4Transform3D	TraverseVolumeTree (const G4LogicalVolume *const, const G4int)=0
virtual void	UserinfoWrite (xercesc::DOMElement *)
G4Transform3D	Write (const G4String &filename, const G4LogicalVolume *const topLog, const G4String &schemaPath, const G4int depth, G4bool storeReferences=true)

Static Public Member Functions
static void	SetAddPointerToName (G4bool)

Protected Member Functions
void	AddAuxInfo (G4GDMLAuxListType *auxInfoList, xercesc::DOMElement *element)
DepthMapType &	DepthMap ()
G4bool	FileExists (const G4String &) const
	G4GDMLWriteDefine ()
G4String	Modularize (const G4VPhysicalVolume *const topvol, const G4int depth)
xercesc::DOMAttr *	NewAttribute (const G4String &, const G4double &)
xercesc::DOMAttr *	NewAttribute (const G4String &, const G4String &)
xercesc::DOMElement *	NewElement (const G4String &)
void	Position_vectorWrite (xercesc::DOMElement *, const G4String &, const G4String &, const G4ThreeVector &)
PhysVolumeMapType &	PvolumeMap ()
void	Rotation_vectorWrite (xercesc::DOMElement *, const G4String &, const G4String &, const G4ThreeVector &)
void	Scale_vectorWrite (xercesc::DOMElement *, const G4String &, const G4String &, const G4ThreeVector &)
VolumeMapType &	VolumeMap ()
virtual	~G4GDMLWriteDefine ()

Protected Attributes
G4GDMLAuxListType	auxList
xercesc::DOMElement *	defineElement = nullptr
xercesc::DOMDocument *	doc = nullptr
xercesc::DOMElement *	extElement = nullptr
G4bool	overwriteOutputFile = false
G4String	SchemaLocation
xercesc::DOMElement *	userinfoElement = nullptr

Static Protected Attributes
static G4bool	addPointerToName = true
static const G4double	kAngularPrecision = DBL_EPSILON
static const G4double	kLinearPrecision = DBL_EPSILON
static const G4double	kRelativePrecision = DBL_EPSILON

Private Types
using	DepthMapType = std::map< G4int, G4int >
using	PhysVolumeMapType = std::map< const G4VPhysicalVolume *, G4String >
using	VolumeMapType = std::map< const G4LogicalVolume *, G4Transform3D >

Detailed Description

Definition at line 43 of file G4GDMLWriteDefine.hh.

Member Typedef Documentation

DepthMapType

using G4GDMLWrite::DepthMapType = std::map<G4int, G4int>

privateinherited

Definition at line 55 of file G4GDMLWrite.hh.

PhysVolumeMapType

using G4GDMLWrite::PhysVolumeMapType = std::map<const G4VPhysicalVolume*, G4String>

privateinherited

Definition at line 54 of file G4GDMLWrite.hh.

VolumeMapType

using G4GDMLWrite::VolumeMapType = std::map<const G4LogicalVolume*, G4Transform3D>

privateinherited

Definition at line 53 of file G4GDMLWrite.hh.

Constructor & Destructor Documentation

G4GDMLWriteDefine()

G4GDMLWriteDefine::G4GDMLWriteDefine ( )

protected

Definition at line 39 of file G4GDMLWriteDefine.cc.

  : G4GDMLWrite()
{
}

~G4GDMLWriteDefine()

G4GDMLWriteDefine::~G4GDMLWriteDefine ( )

protectedvirtual

Definition at line 45 of file G4GDMLWriteDefine.cc.

{
}

Member Function Documentation

AddAuxiliary()

void G4GDMLWrite::AddAuxiliary ( G4GDMLAuxStructType  myaux )

inherited

Definition at line 398 of file G4GDMLWrite.cc.

{
  auxList.push_back(myaux);
}

References G4GDMLWrite::auxList.

AddAuxInfo()

void G4GDMLWrite::AddAuxInfo ( G4GDMLAuxListType *  auxInfoList, xercesc::DOMElement *  element  )

protectedinherited

Definition at line 94 of file G4GDMLWrite.cc.

{
  for(auto iaux = auxInfoList->cbegin(); iaux != auxInfoList->cend(); ++iaux)
  {
    xercesc::DOMElement* auxiliaryElement = NewElement("auxiliary");
    element->appendChild(auxiliaryElement);
 
    auxiliaryElement->setAttributeNode(NewAttribute("auxtype", (*iaux).type));
    auxiliaryElement->setAttributeNode(NewAttribute("auxvalue", (*iaux).value));
    if(((*iaux).unit) != "")
    {
      auxiliaryElement->setAttributeNode(NewAttribute("auxunit", (*iaux).unit));
    }
 
    if(iaux->auxList)
    {
      AddAuxInfo(iaux->auxList, auxiliaryElement);
    }
  }
  return;
}

References G4GDMLWrite::AddAuxInfo(), G4GDMLWrite::NewAttribute(), and G4GDMLWrite::NewElement().

Referenced by G4GDMLWrite::AddAuxInfo(), G4GDMLWriteStructure::TraverseVolumeTree(), and G4GDMLWrite::UserinfoWrite().

AddExtension()

void G4GDMLWrite::AddExtension ( xercesc::DOMElement *  , const G4LogicalVolume * const    )

virtualinherited

Definition at line 80 of file G4GDMLWrite.cc.

{
  // Empty implementation. To be overwritten by user for specific extensions
  // related to attributes associated to volumes
}

Referenced by G4GDMLWriteStructure::TraverseVolumeTree().

AddModule() [1/2]

void G4GDMLWrite::AddModule ( const G4int  depth )

inherited

Definition at line 361 of file G4GDMLWrite.cc.

{
  if(depth < 0)
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "Depth must be a positive number!");
  }
  if(DepthMap().find(depth) != DepthMap().end())
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "Adding module(s) at this depth is already requested!");
  }
  DepthMap()[depth] = 0;
}

References G4GDMLWrite::DepthMap(), FatalException, and G4Exception().

AddModule() [2/2]

void G4GDMLWrite::AddModule ( const G4VPhysicalVolume *const  topVol )

inherited

Definition at line 327 of file G4GDMLWrite.cc.

{
  G4String fname = GenerateName(physvol->GetName(), physvol);
  G4cout << "G4GDML: Adding module '" << fname << "'..." << G4endl;
 
  if(physvol == nullptr)
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "Invalid NULL pointer is specified for modularization!");
    return;
  }
  if(dynamic_cast<const G4PVDivision*>(physvol))
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "It is not possible to modularize by divisionvol!");
    return;
  }
  if(physvol->IsParameterised())
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "It is not possible to modularize by parameterised volume!");
    return;
  }
  if(physvol->IsReplicated())
  {
    G4Exception("G4GDMLWrite::AddModule()", "InvalidSetup", FatalException,
                "It is not possible to modularize by replicated volume!");
    return;
  }
 
  PvolumeMap()[physvol] = fname;
}

References FatalException, test::fname, G4cout, G4endl, G4Exception(), G4GDMLWrite::GenerateName(), G4VPhysicalVolume::GetName(), G4VPhysicalVolume::IsParameterised(), G4VPhysicalVolume::IsReplicated(), and G4GDMLWrite::PvolumeMap().

AddPosition()

void G4GDMLWriteDefine::AddPosition ( const G4String &  name, const G4ThreeVector &  pos  )

inline

Definition at line 73 of file G4GDMLWriteDefine.hh.

    {
      Position_vectorWrite(defineElement, "position", name, pos);
    }

References defineElement, G4InuclParticleNames::name(), pos, and Position_vectorWrite().

Referenced by G4GDMLWriteSolids::TessellatedWrite(), and G4GDMLWriteSolids::TetWrite().

DefineWrite()

void G4GDMLWriteDefine::DefineWrite ( xercesc::DOMElement *  element )

virtual

Implements G4GDMLWrite.

Definition at line 137 of file G4GDMLWriteDefine.cc.

{
#ifdef G4VERBOSE
  G4cout << "G4GDML: Writing definitions..." << G4endl;
#endif
  defineElement = NewElement("define");
  element->appendChild(defineElement);
}

References defineElement, G4cout, G4endl, and G4GDMLWrite::NewElement().

DepthMap()

G4GDMLWrite::DepthMapType & G4GDMLWrite::DepthMap ( )

protectedinherited

Definition at line 73 of file G4GDMLWrite.cc.

{
  static DepthMapType instance;
  return instance;
}

Referenced by G4GDMLWrite::AddModule(), and G4GDMLWrite::Modularize().

ExtensionWrite()

void G4GDMLWrite::ExtensionWrite ( xercesc::DOMElement *  )

virtualinherited

Definition at line 88 of file G4GDMLWrite.cc.

{
  // Empty implementation. To be overwritten by user for specific extensions
}

Referenced by G4GDMLWrite::Write().

FileExists()

G4bool G4GDMLWrite::FileExists ( const G4String &  fname ) const

protectedinherited

Definition at line 53 of file G4GDMLWrite.cc.

{
  struct stat FileInfo;
  return (stat(fname.c_str(), &FileInfo) == 0);
}

References test::fname.

Referenced by G4GDMLWrite::Write().

FirstpositionWrite()

void G4GDMLWriteDefine::FirstpositionWrite ( xercesc::DOMElement *  element, const G4String &  name, const G4ThreeVector &  pos  )

inline

Definition at line 68 of file G4GDMLWriteDefine.hh.

    {
      Position_vectorWrite(element, "firstposition", name, pos);
    }

References G4InuclParticleNames::name(), pos, and Position_vectorWrite().

Referenced by G4GDMLWriteSolids::BooleanWrite().

FirstrotationWrite()

void G4GDMLWriteDefine::FirstrotationWrite ( xercesc::DOMElement *  element, const G4String &  name, const G4ThreeVector &  rot  )

inline

Definition at line 63 of file G4GDMLWriteDefine.hh.

    {
      Rotation_vectorWrite(element, "firstrotation", name, rot);
    }

References G4InuclParticleNames::name(), and Rotation_vectorWrite().

Referenced by G4GDMLWriteSolids::BooleanWrite().

GenerateName()

G4String G4GDMLWrite::GenerateName ( const G4String &  name, const void * const  ptr  )

inherited

Definition at line 132 of file G4GDMLWrite.cc.

{
  G4String nameOut;
  std::stringstream stream;
  stream << name;
  if(addPointerToName)
  {
    stream << ptr;
  };
 
  nameOut = G4String(stream.str());
  std::vector<char> toremove = { ' ', '/', ':', '#', '+' };
  for(auto c : toremove)
  {
    if(G4StrUtil::contains(nameOut, c))
    {
      std::replace(nameOut.begin(), nameOut.end(), c, '_');
    }
  }
  return nameOut;
}

References G4GDMLWrite::addPointerToName, G4StrUtil::contains(), and G4InuclParticleNames::name().

Referenced by G4GDMLWrite::AddModule(), G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteStructure::BorderSurfaceCache(), G4GDMLWriteSolids::BoxWrite(), G4GDMLWriteSolids::ConeWrite(), G4GDMLWriteSolids::CutTubeWrite(), G4GDMLWriteStructure::DivisionvolWrite(), G4GDMLWriteSolids::ElconeWrite(), G4GDMLWriteMaterials::ElementWrite(), G4GDMLWriteSolids::EllipsoidWrite(), G4GDMLWriteSolids::EltubeWrite(), G4GDMLParser::ExportRegions(), G4GDMLWriteSolids::GenericPolyconeWrite(), G4GDMLWriteSolids::GenTrapWrite(), G4GDMLWriteSolids::HypeWrite(), G4GDMLWriteMaterials::IsotopeWrite(), G4GDMLWriteMaterials::MaterialWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteSolids::OpticalSurfaceWrite(), G4GDMLWriteSolids::OrbWrite(), G4GDMLWriteSolids::ParaboloidWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteParamvol::ParamvolAlgorithmWrite(), G4GDMLWriteParamvol::ParamvolWrite(), G4GDMLWriteSolids::ParaWrite(), G4GDMLWriteStructure::PhysvolWrite(), G4GDMLWriteSolids::PolyconeWrite(), G4GDMLWriteSolids::PolyhedraWrite(), G4GDMLWriteMaterials::PropertyConstWrite(), G4GDMLWriteMaterials::PropertyVectorWrite(), G4GDMLWriteMaterials::PropertyWrite(), G4GDMLWriteSolids::PropertyWrite(), G4GDMLWriteStructure::ReplicavolWrite(), G4GDMLWriteSolids::ScaledWrite(), G4GDMLWriteSetup::SetupWrite(), G4GDMLWriteStructure::SkinSurfaceCache(), G4GDMLWriteSolids::SphereWrite(), G4GDMLWriteSolids::TessellatedWrite(), G4GDMLWriteSolids::TetWrite(), G4GDMLWriteSolids::TorusWrite(), G4GDMLWriteSolids::TrapWrite(), G4GDMLWriteStructure::TraverseVolumeTree(), G4GDMLWriteSolids::TrdWrite(), G4GDMLWriteSolids::TubeWrite(), G4GDMLWriteSolids::TwistedboxWrite(), G4GDMLWriteSolids::TwistedtrapWrite(), G4GDMLWriteSolids::TwistedtrdWrite(), G4GDMLWriteSolids::TwistedtubsWrite(), and G4GDMLWriteSolids::XtruWrite().

GetAngles()

G4ThreeVector G4GDMLWriteDefine::GetAngles

(

const G4RotationMatrix &

mtx

)

Definition at line 50 of file G4GDMLWriteDefine.cc.

{
  G4double x, y, z;
  G4RotationMatrix mat = mtx;
  mat.rectify();  // Rectify matrix from possible roundoff errors
 
  // Direction of rotation given by left-hand rule; clockwise rotation
 
  static const G4double kMatrixPrecision = 10E-10;
  const G4double cosb = std::sqrt(mtx.xx() * mtx.xx() + mtx.yx() * mtx.yx());
 
  if(cosb > kMatrixPrecision)
  {
    x = std::atan2(mtx.zy(), mtx.zz());
    y = std::atan2(-mtx.zx(), cosb);
    z = std::atan2(mtx.yx(), mtx.xx());
  }
  else
  {
    x = std::atan2(-mtx.yz(), mtx.yy());
    y = std::atan2(-mtx.zx(), cosb);
    z = 0.0;
  }
 
  return G4ThreeVector(x, y, z);
}

References CLHEP::HepRotation::rectify(), CLHEP::HepRotation::xx(), CLHEP::HepRotation::yx(), CLHEP::HepRotation::yy(), CLHEP::HepRotation::yz(), CLHEP::HepRotation::zx(), CLHEP::HepRotation::zy(), and CLHEP::HepRotation::zz().

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteStructure::PhysvolWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

MaterialsWrite()

virtual void G4GDMLWrite::MaterialsWrite ( xercesc::DOMElement *  )

pure virtualinherited

Implemented in G4GDMLWriteMaterials.

Referenced by G4GDMLWrite::Write().

Modularize()

G4String G4GDMLWrite::Modularize ( const G4VPhysicalVolume *const  topvol, const G4int  depth  )

protectedinherited

Definition at line 377 of file G4GDMLWrite.cc.

{
  if(PvolumeMap().find(physvol) != PvolumeMap().cend())
  {
    return PvolumeMap()[physvol];  // Modularize via physvol
  }
 
  if(DepthMap().find(depth) != DepthMap().cend())  // Modularize via depth
  {
    std::stringstream stream;
    stream << "depth" << depth << "_module" << DepthMap()[depth] << ".gdml";
    DepthMap()[depth]++;  // There can be more modules at this depth!
    return G4String(stream.str());
  }
 
  return G4String("");  // Empty string for module name = no modularization
                        // was requested at that level/physvol!
}

References G4GDMLWrite::DepthMap(), and G4GDMLWrite::PvolumeMap().

Referenced by G4GDMLWriteStructure::TraverseVolumeTree().

NewAttribute() [1/2]

xercesc::DOMAttr * G4GDMLWrite::NewAttribute ( const G4String &  name, const G4double &  value  )

protectedinherited

Definition at line 171 of file G4GDMLWrite.cc.

{
  XMLCh* tempStr = NULL;
  tempStr = xercesc::XMLString::transcode(name);
  xercesc::DOMAttr* att = doc->createAttribute(tempStr);
  xercesc::XMLString::release(&tempStr);
 
  std::ostringstream ostream;
  ostream.precision(15);
  ostream << value;
  G4String str = ostream.str();
 
  tempStr = xercesc::XMLString::transcode(str);
  att->setValue(tempStr);
  xercesc::XMLString::release(&tempStr);
 
  return att;
}

References G4GDMLWrite::doc, and G4InuclParticleNames::name().

NewAttribute() [2/2]

xercesc::DOMAttr * G4GDMLWrite::NewAttribute ( const G4String &  name, const G4String &  value  )

protectedinherited

Definition at line 155 of file G4GDMLWrite.cc.

{
  XMLCh* tempStr = NULL;
  tempStr = xercesc::XMLString::transcode(name);
  xercesc::DOMAttr* att = doc->createAttribute(tempStr);
  xercesc::XMLString::release(&tempStr);
 
  tempStr = xercesc::XMLString::transcode(value);
  att->setValue(tempStr);
  xercesc::XMLString::release(&tempStr);
 
  return att;
}

References G4GDMLWrite::doc, and G4InuclParticleNames::name().

Referenced by G4GDMLWrite::AddAuxInfo(), G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteMaterials::AtomWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteStructure::BorderSurfaceCache(), G4GDMLWriteParamvol::Box_dimensionsWrite(), G4GDMLWriteSolids::BoxWrite(), G4GDMLWriteParamvol::Cone_dimensionsWrite(), G4GDMLWriteSolids::ConeWrite(), G4GDMLWriteSolids::CutTubeWrite(), G4GDMLWriteStructure::DivisionvolWrite(), G4GDMLWriteMaterials::DWrite(), G4GDMLWriteSolids::ElconeWrite(), G4GDMLWriteMaterials::ElementWrite(), G4GDMLWriteParamvol::Ellipsoid_dimensionsWrite(), G4GDMLWriteSolids::EllipsoidWrite(), G4GDMLWriteSolids::EltubeWrite(), G4GDMLWriteSolids::GenericPolyconeWrite(), G4GDMLWriteSolids::GenTrapWrite(), G4GDMLWriteParamvol::Hype_dimensionsWrite(), G4GDMLWriteSolids::HypeWrite(), G4GDMLWriteMaterials::IsotopeWrite(), G4GDMLWriteMaterials::MaterialWrite(), G4GDMLWriteMaterials::MEEWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteSolids::OpticalSurfaceWrite(), G4GDMLWriteParamvol::Orb_dimensionsWrite(), G4GDMLWriteSolids::OrbWrite(), G4GDMLWriteParamvol::Para_dimensionsWrite(), G4GDMLWriteSolids::ParaboloidWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteParamvol::ParamvolWrite(), G4GDMLWriteSolids::ParaWrite(), G4GDMLWriteStructure::PhysvolWrite(), G4GDMLWriteParamvol::Polycone_dimensionsWrite(), G4GDMLWriteSolids::PolyconeWrite(), G4GDMLWriteParamvol::Polyhedra_dimensionsWrite(), G4GDMLWriteSolids::PolyhedraWrite(), Position_vectorWrite(), G4GDMLWriteMaterials::PropertyConstWrite(), G4GDMLWriteMaterials::PropertyVectorWrite(), G4GDMLWriteMaterials::PropertyWrite(), G4GDMLWriteSolids::PropertyWrite(), G4GDMLWriteMaterials::PWrite(), G4GDMLWriteStructure::ReplicavolWrite(), Rotation_vectorWrite(), G4GDMLWriteSolids::RZPointWrite(), Scale_vectorWrite(), G4GDMLWriteSolids::ScaledWrite(), G4GDMLWriteSetup::SetupWrite(), G4GDMLWriteStructure::SkinSurfaceCache(), G4GDMLWriteParamvol::Sphere_dimensionsWrite(), G4GDMLWriteSolids::SphereWrite(), G4GDMLWriteSolids::TessellatedWrite(), G4GDMLWriteSolids::TetWrite(), G4GDMLWriteParamvol::Torus_dimensionsWrite(), G4GDMLWriteSolids::TorusWrite(), G4GDMLWriteParamvol::Trap_dimensionsWrite(), G4GDMLWriteSolids::TrapWrite(), G4GDMLWriteStructure::TraverseVolumeTree(), G4GDMLWriteParamvol::Trd_dimensionsWrite(), G4GDMLWriteSolids::TrdWrite(), G4GDMLWriteParamvol::Tube_dimensionsWrite(), G4GDMLWriteSolids::TubeWrite(), G4GDMLWriteSolids::TwistedboxWrite(), G4GDMLWriteSolids::TwistedtrapWrite(), G4GDMLWriteSolids::TwistedtrdWrite(), G4GDMLWriteSolids::TwistedtubsWrite(), G4GDMLWriteMaterials::TWrite(), G4GDMLWrite::Write(), G4GDMLWriteSolids::XtruWrite(), and G4GDMLWriteSolids::ZplaneWrite().

NewElement()

xercesc::DOMElement * G4GDMLWrite::NewElement ( const G4String &  name )

protectedinherited

Definition at line 192 of file G4GDMLWrite.cc.

{
  XMLCh* tempStr = NULL;
  tempStr = xercesc::XMLString::transcode(name);
  xercesc::DOMElement* elem = doc->createElement(tempStr);
  xercesc::XMLString::release(&tempStr);
 
  return elem;
}

References G4GDMLWrite::doc, elem, and G4InuclParticleNames::name().

Referenced by G4GDMLWrite::AddAuxInfo(), G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteMaterials::AtomWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteStructure::BorderSurfaceCache(), G4GDMLWriteParamvol::Box_dimensionsWrite(), G4GDMLWriteSolids::BoxWrite(), G4GDMLWriteParamvol::Cone_dimensionsWrite(), G4GDMLWriteSolids::ConeWrite(), G4GDMLWriteSolids::CutTubeWrite(), DefineWrite(), G4GDMLWriteStructure::DivisionvolWrite(), G4GDMLWriteMaterials::DWrite(), G4GDMLWriteSolids::ElconeWrite(), G4GDMLWriteMaterials::ElementWrite(), G4GDMLWriteParamvol::Ellipsoid_dimensionsWrite(), G4GDMLWriteSolids::EllipsoidWrite(), G4GDMLWriteSolids::EltubeWrite(), G4GDMLWriteSolids::GenericPolyconeWrite(), G4GDMLWriteSolids::GenTrapWrite(), G4GDMLWriteParamvol::Hype_dimensionsWrite(), G4GDMLWriteSolids::HypeWrite(), G4GDMLWriteMaterials::IsotopeWrite(), G4GDMLWriteMaterials::MaterialsWrite(), G4GDMLWriteMaterials::MaterialWrite(), G4GDMLWriteMaterials::MEEWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteSolids::OpticalSurfaceWrite(), G4GDMLWriteParamvol::Orb_dimensionsWrite(), G4GDMLWriteSolids::OrbWrite(), G4GDMLWriteParamvol::Para_dimensionsWrite(), G4GDMLWriteSolids::ParaboloidWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteParamvol::ParamvolWrite(), G4GDMLWriteSolids::ParaWrite(), G4GDMLWriteStructure::PhysvolWrite(), G4GDMLWriteParamvol::Polycone_dimensionsWrite(), G4GDMLWriteSolids::PolyconeWrite(), G4GDMLWriteParamvol::Polyhedra_dimensionsWrite(), G4GDMLWriteSolids::PolyhedraWrite(), Position_vectorWrite(), G4GDMLWriteMaterials::PropertyConstWrite(), G4GDMLWriteMaterials::PropertyVectorWrite(), G4GDMLWriteMaterials::PropertyWrite(), G4GDMLWriteSolids::PropertyWrite(), G4GDMLWriteMaterials::PWrite(), G4GDMLWriteStructure::ReplicavolWrite(), Rotation_vectorWrite(), G4GDMLWriteSolids::RZPointWrite(), Scale_vectorWrite(), G4GDMLWriteSolids::ScaledWrite(), G4GDMLWriteSetup::SetupWrite(), G4GDMLWriteStructure::SkinSurfaceCache(), G4GDMLWriteSolids::SolidsWrite(), G4GDMLWriteParamvol::Sphere_dimensionsWrite(), G4GDMLWriteSolids::SphereWrite(), G4GDMLWriteStructure::StructureWrite(), G4GDMLWriteSolids::TessellatedWrite(), G4GDMLWriteSolids::TetWrite(), G4GDMLWriteParamvol::Torus_dimensionsWrite(), G4GDMLWriteSolids::TorusWrite(), G4GDMLWriteParamvol::Trap_dimensionsWrite(), G4GDMLWriteSolids::TrapWrite(), G4GDMLWriteStructure::TraverseVolumeTree(), G4GDMLWriteParamvol::Trd_dimensionsWrite(), G4GDMLWriteSolids::TrdWrite(), G4GDMLWriteParamvol::Tube_dimensionsWrite(), G4GDMLWriteSolids::TubeWrite(), G4GDMLWriteSolids::TwistedboxWrite(), G4GDMLWriteSolids::TwistedtrapWrite(), G4GDMLWriteSolids::TwistedtrdWrite(), G4GDMLWriteSolids::TwistedtubsWrite(), G4GDMLWriteMaterials::TWrite(), G4GDMLWrite::UserinfoWrite(), G4GDMLWriteSolids::XtruWrite(), and G4GDMLWriteSolids::ZplaneWrite().

Position_vectorWrite()

void G4GDMLWriteDefine::Position_vectorWrite ( xercesc::DOMElement *  element, const G4String &  tag, const G4String &  name, const G4ThreeVector &  pos  )

protected

Definition at line 118 of file G4GDMLWriteDefine.cc.

{
  const G4double x = (std::fabs(pos.x()) < kLinearPrecision) ? 0.0 : pos.x();
  const G4double y = (std::fabs(pos.y()) < kLinearPrecision) ? 0.0 : pos.y();
  const G4double z = (std::fabs(pos.z()) < kLinearPrecision) ? 0.0 : pos.z();
 
  xercesc::DOMElement* positionElement = NewElement(tag);
  positionElement->setAttributeNode(NewAttribute("name", name));
  positionElement->setAttributeNode(NewAttribute("x", x / mm));
  positionElement->setAttributeNode(NewAttribute("y", y / mm));
  positionElement->setAttributeNode(NewAttribute("z", z / mm));
  positionElement->setAttributeNode(NewAttribute("unit", "mm"));
  element->appendChild(positionElement);
}

References kLinearPrecision, mm, G4InuclParticleNames::name(), G4GDMLWrite::NewAttribute(), G4GDMLWrite::NewElement(), and pos.

Referenced by AddPosition(), FirstpositionWrite(), and PositionWrite().

PositionWrite()

void G4GDMLWriteDefine::PositionWrite ( xercesc::DOMElement *  element, const G4String &  name, const G4ThreeVector &  pos  )

inline

Definition at line 58 of file G4GDMLWriteDefine.hh.

    {
      Position_vectorWrite(element, "position", name, pos);
    }

References G4InuclParticleNames::name(), pos, and Position_vectorWrite().

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteStructure::PhysvolWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

PvolumeMap()

G4GDMLWrite::PhysVolumeMapType & G4GDMLWrite::PvolumeMap ( )

protectedinherited

Definition at line 66 of file G4GDMLWrite.cc.

{
  static PhysVolumeMapType instance;
  return instance;
}

Referenced by G4GDMLWrite::AddModule(), and G4GDMLWrite::Modularize().

Rotation_vectorWrite()

void G4GDMLWriteDefine::Rotation_vectorWrite ( xercesc::DOMElement *  element, const G4String &  tag, const G4String &  name, const G4ThreeVector &  rot  )

protected

Definition at line 99 of file G4GDMLWriteDefine.cc.

{
  const G4double x = (std::fabs(rot.x()) < kAngularPrecision) ? 0.0 : rot.x();
  const G4double y = (std::fabs(rot.y()) < kAngularPrecision) ? 0.0 : rot.y();
  const G4double z = (std::fabs(rot.z()) < kAngularPrecision) ? 0.0 : rot.z();
 
  xercesc::DOMElement* rotationElement = NewElement(tag);
  rotationElement->setAttributeNode(NewAttribute("name", name));
  rotationElement->setAttributeNode(NewAttribute("x", x / degree));
  rotationElement->setAttributeNode(NewAttribute("y", y / degree));
  rotationElement->setAttributeNode(NewAttribute("z", z / degree));
  rotationElement->setAttributeNode(NewAttribute("unit", "deg"));
  element->appendChild(rotationElement);
}

References degree, kAngularPrecision, G4InuclParticleNames::name(), G4GDMLWrite::NewAttribute(), G4GDMLWrite::NewElement(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by FirstrotationWrite(), and RotationWrite().

RotationWrite()

void G4GDMLWriteDefine::RotationWrite ( xercesc::DOMElement *  element, const G4String &  name, const G4ThreeVector &  rot  )

inline

Definition at line 53 of file G4GDMLWriteDefine.hh.

    {
      Rotation_vectorWrite(element, "rotation", name, rot);
    }

References G4InuclParticleNames::name(), and Rotation_vectorWrite().

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteParamvol::ParametersWrite(), G4GDMLWriteStructure::PhysvolWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

Scale_vectorWrite()

void G4GDMLWriteDefine::Scale_vectorWrite ( xercesc::DOMElement *  element, const G4String &  tag, const G4String &  name, const G4ThreeVector &  scl  )

protected

Definition at line 78 of file G4GDMLWriteDefine.cc.

{
  const G4double x =
    (std::fabs(scl.x() - 1.0) < kRelativePrecision) ? 1.0 : scl.x();
  const G4double y =
    (std::fabs(scl.y() - 1.0) < kRelativePrecision) ? 1.0 : scl.y();
  const G4double z =
    (std::fabs(scl.z() - 1.0) < kRelativePrecision) ? 1.0 : scl.z();
 
  xercesc::DOMElement* scaleElement = NewElement(tag);
  scaleElement->setAttributeNode(NewAttribute("name", name));
  scaleElement->setAttributeNode(NewAttribute("x", x));
  scaleElement->setAttributeNode(NewAttribute("y", y));
  scaleElement->setAttributeNode(NewAttribute("z", z));
  element->appendChild(scaleElement);
}

References kRelativePrecision, G4InuclParticleNames::name(), G4GDMLWrite::NewAttribute(), G4GDMLWrite::NewElement(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by ScaleWrite().

ScaleWrite()

void G4GDMLWriteDefine::ScaleWrite ( xercesc::DOMElement *  element, const G4String &  name, const G4ThreeVector &  scl  )

inline

Definition at line 48 of file G4GDMLWriteDefine.hh.

    {
      Scale_vectorWrite(element, "scale", name, scl);
    }

References G4InuclParticleNames::name(), and Scale_vectorWrite().

Referenced by G4GDMLWriteStructure::PhysvolWrite(), G4GDMLWriteSolids::ScaledWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

SetAddPointerToName()

void G4GDMLWrite::SetAddPointerToName ( G4bool  set )

staticinherited

Definition at line 410 of file G4GDMLWrite.cc.

{
  addPointerToName = set;
}

References G4GDMLWrite::addPointerToName.

SetOutputFileOverwrite()

void G4GDMLWrite::SetOutputFileOverwrite ( G4bool  flag )

inherited

Definition at line 404 of file G4GDMLWrite.cc.

{
  overwriteOutputFile = flag; 
}

References G4GDMLWrite::overwriteOutputFile.

SetupWrite()

virtual void G4GDMLWrite::SetupWrite ( xercesc::DOMElement *  , const G4LogicalVolume * const    )

pure virtualinherited

Implemented in G4GDMLWriteSetup.

Referenced by G4GDMLWrite::Write().

SolidsWrite()

virtual void G4GDMLWrite::SolidsWrite ( xercesc::DOMElement *  )

pure virtualinherited

Implemented in G4GDMLWriteSolids.

Referenced by G4GDMLWrite::Write().

StructureWrite()

virtual void G4GDMLWrite::StructureWrite ( xercesc::DOMElement *  )

pure virtualinherited

Implemented in G4GDMLWriteStructure.

Referenced by G4GDMLWrite::Write().

SurfacesWrite()

virtual void G4GDMLWrite::SurfacesWrite ( )

pure virtualinherited

Implemented in G4GDMLWriteStructure.

Referenced by G4GDMLWrite::Write().

TraverseVolumeTree()

virtual G4Transform3D G4GDMLWrite::TraverseVolumeTree ( const G4LogicalVolume * const  , const  G4int  )

pure virtualinherited

Implemented in G4GDMLWriteStructure.

Referenced by G4GDMLWrite::Write().

UserinfoWrite()

void G4GDMLWrite::UserinfoWrite ( xercesc::DOMElement *  gdmlElement )

virtualinherited

Definition at line 118 of file G4GDMLWrite.cc.

{
  if(auxList.size() > 0)
  {
#ifdef G4VERBOSE
    G4cout << "G4GDML: Writing userinfo..." << G4endl;
#endif
    userinfoElement = NewElement("userinfo");
    gdmlElement->appendChild(userinfoElement);
    AddAuxInfo(&auxList, userinfoElement);
  }
}

References G4GDMLWrite::AddAuxInfo(), G4GDMLWrite::auxList, G4cout, G4endl, G4GDMLWrite::NewElement(), and G4GDMLWrite::userinfoElement.

Referenced by G4GDMLWrite::Write().

VolumeMap()

G4GDMLWrite::VolumeMapType & G4GDMLWrite::VolumeMap ( )

protectedinherited

Definition at line 60 of file G4GDMLWrite.cc.

{
  static VolumeMapType instance;
  return instance;
}

Referenced by G4GDMLWriteStructure::TraverseVolumeTree(), and G4GDMLWrite::Write().

Write()

G4Transform3D G4GDMLWrite::Write ( const G4String &  filename, const G4LogicalVolume *const  topLog, const G4String &  schemaPath, const G4int  depth, G4bool  storeReferences = true  )

inherited

Definition at line 203 of file G4GDMLWrite.cc.

{
  SchemaLocation   = setSchemaLocation;
  addPointerToName = refs;
#ifdef G4VERBOSE
  if(depth == 0)
  {
    G4cout << "G4GDML: Writing '" << fname << "'..." << G4endl;
  }
  else
  {
    G4cout << "G4GDML: Writing module '" << fname << "'..." << G4endl;
  }
#endif
  if(!overwriteOutputFile && FileExists(fname))
  {
    G4String ErrorMessage = "File '" + fname + "' already exists!";
    G4Exception("G4GDMLWrite::Write()", "InvalidSetup", FatalException,
                ErrorMessage);
  }
 
  VolumeMap().clear();  // The module map is global for all modules,
                        // so clear it only at once!
 
  XMLCh* tempStr = NULL;
  tempStr = xercesc::XMLString::transcode("LS");
  xercesc::DOMImplementationRegistry::getDOMImplementation(tempStr);
  xercesc::XMLString::release(&tempStr);
  tempStr = xercesc::XMLString::transcode("Range");
  xercesc::DOMImplementation* impl =
    xercesc::DOMImplementationRegistry::getDOMImplementation(tempStr);
  xercesc::XMLString::release(&tempStr);
  tempStr = xercesc::XMLString::transcode("gdml");
  doc                       = impl->createDocument(0, tempStr, 0);
  xercesc::XMLString::release(&tempStr);
  xercesc::DOMElement* gdml = doc->getDocumentElement();
 
#if XERCES_VERSION_MAJOR >= 3
  // DOM L3 as per Xerces 3.0 API
  xercesc::DOMLSSerializer* writer =
    ((xercesc::DOMImplementationLS*) impl)->createLSSerializer();
 
  xercesc::DOMConfiguration* dc = writer->getDomConfig();
  dc->setParameter(xercesc::XMLUni::fgDOMWRTFormatPrettyPrint, true);
 
#else
 
  xercesc::DOMWriter* writer =
    ((xercesc::DOMImplementationLS*) impl)->createDOMWriter();
 
  if(writer->canSetFeature(xercesc::XMLUni::fgDOMWRTFormatPrettyPrint, true))
    writer->setFeature(xercesc::XMLUni::fgDOMWRTFormatPrettyPrint, true);
 
#endif
 
  gdml->setAttributeNode(
    NewAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"));
  gdml->setAttributeNode(
    NewAttribute("xsi:noNamespaceSchemaLocation", SchemaLocation));
 
  ExtensionWrite(gdml);
  DefineWrite(gdml);
  MaterialsWrite(gdml);
  SolidsWrite(gdml);
  StructureWrite(gdml);
  UserinfoWrite(gdml);
  SetupWrite(gdml, logvol);
 
  G4Transform3D R = TraverseVolumeTree(logvol, depth);
 
  SurfacesWrite();
  xercesc::XMLFormatTarget* myFormTarget =
    new xercesc::LocalFileFormatTarget(fname.c_str());
 
  try
  {
#if XERCES_VERSION_MAJOR >= 3
    // DOM L3 as per Xerces 3.0 API
    xercesc::DOMLSOutput* theOutput =
      ((xercesc::DOMImplementationLS*) impl)->createLSOutput();
    theOutput->setByteStream(myFormTarget);
    writer->write(doc, theOutput);
#else
    writer->writeNode(myFormTarget, *doc);
#endif
  } catch(const xercesc::XMLException& toCatch)
  {
    char* message = xercesc::XMLString::transcode(toCatch.getMessage());
    G4cout << "G4GDML: Exception message is: " << message << G4endl;
    xercesc::XMLString::release(&message);
    return G4Transform3D::Identity;
  } catch(const xercesc::DOMException& toCatch)
  {
    char* message = xercesc::XMLString::transcode(toCatch.msg);
    G4cout << "G4GDML: Exception message is: " << message << G4endl;
    xercesc::XMLString::release(&message);
    return G4Transform3D::Identity;
  } catch(...)
  {
    G4cout << "G4GDML: Unexpected Exception!" << G4endl;
    return G4Transform3D::Identity;
  }
 
  delete myFormTarget;
  writer->release();
 
  if(depth == 0)
  {
    G4cout << "G4GDML: Writing '" << fname << "' done !" << G4endl;
  }
  else
  {
#ifdef G4VERBOSE
    G4cout << "G4GDML: Writing module '" << fname << "' done !" << G4endl;
#endif
  }
 
  return R;
}

References G4GDMLWrite::addPointerToName, G4GDMLWrite::DefineWrite(), G4GDMLWrite::doc, G4GDMLWrite::ExtensionWrite(), FatalException, G4GDMLWrite::FileExists(), test::fname, G4cout, G4endl, G4Exception(), HepGeom::Transform3D::Identity, G4GDMLWrite::MaterialsWrite(), G4GDMLWrite::NewAttribute(), G4GDMLWrite::overwriteOutputFile, G4GDMLWrite::SchemaLocation, G4GDMLWrite::SetupWrite(), G4GDMLWrite::SolidsWrite(), G4GDMLWrite::StructureWrite(), G4GDMLWrite::SurfacesWrite(), G4GDMLWrite::TraverseVolumeTree(), G4GDMLWrite::UserinfoWrite(), and G4GDMLWrite::VolumeMap().

Referenced by G4GDMLWriteStructure::TraverseVolumeTree().

Field Documentation

addPointerToName

G4bool G4GDMLWrite::addPointerToName = true

staticprotectedinherited

Definition at line 131 of file G4GDMLWrite.hh.

Referenced by G4GDMLWrite::GenerateName(), G4GDMLWrite::SetAddPointerToName(), and G4GDMLWrite::Write().

auxList

G4GDMLAuxListType G4GDMLWrite::auxList

protectedinherited

Definition at line 136 of file G4GDMLWrite.hh.

Referenced by G4GDMLWrite::AddAuxiliary(), and G4GDMLWrite::UserinfoWrite().

defineElement

xercesc::DOMElement* G4GDMLWriteDefine::defineElement = nullptr

protected

Definition at line 98 of file G4GDMLWriteDefine.hh.

Referenced by AddPosition(), DefineWrite(), G4GDMLWriteMaterials::PropertyConstWrite(), G4GDMLWriteMaterials::PropertyVectorWrite(), and G4GDMLWriteSolids::PropertyWrite().

doc

xercesc::DOMDocument* G4GDMLWrite::doc = nullptr

protectedinherited

Definition at line 132 of file G4GDMLWrite.hh.

Referenced by G4GDMLWrite::NewAttribute(), G4GDMLWrite::NewElement(), and G4GDMLWrite::Write().

extElement

xercesc::DOMElement* G4GDMLWrite::extElement = nullptr

protectedinherited

Definition at line 133 of file G4GDMLWrite.hh.

kAngularPrecision

const G4double G4GDMLWriteDefine::kAngularPrecision = DBL_EPSILON

staticprotected

Definition at line 95 of file G4GDMLWriteDefine.hh.

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteStructure::PhysvolWrite(), Rotation_vectorWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

kLinearPrecision

const G4double G4GDMLWriteDefine::kLinearPrecision = DBL_EPSILON

staticprotected

Definition at line 96 of file G4GDMLWriteDefine.hh.

Referenced by G4GDMLWriteStructure::AssemblyWrite(), G4GDMLWriteSolids::BooleanWrite(), G4GDMLWriteSolids::MultiUnionWrite(), G4GDMLWriteStructure::PhysvolWrite(), Position_vectorWrite(), G4GDMLWriteSolids::ScaledWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

kRelativePrecision

const G4double G4GDMLWriteDefine::kRelativePrecision = DBL_EPSILON

staticprotected

Definition at line 94 of file G4GDMLWriteDefine.hh.

Referenced by G4GDMLWriteStructure::PhysvolWrite(), Scale_vectorWrite(), and G4GDMLWriteStructure::TraverseVolumeTree().

overwriteOutputFile

G4bool G4GDMLWrite::overwriteOutputFile = false

protectedinherited

Definition at line 137 of file G4GDMLWrite.hh.

Referenced by G4GDMLWrite::SetOutputFileOverwrite(), and G4GDMLWrite::Write().

SchemaLocation

G4String G4GDMLWrite::SchemaLocation

protectedinherited

Definition at line 130 of file G4GDMLWrite.hh.

Referenced by G4GDMLWriteStructure::TraverseVolumeTree(), and G4GDMLWrite::Write().

userinfoElement

xercesc::DOMElement* G4GDMLWrite::userinfoElement = nullptr

protectedinherited

Definition at line 134 of file G4GDMLWrite.hh.

Referenced by G4GDMLWrite::UserinfoWrite().

---

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

• source/persistency/gdml/include/G4GDMLWriteDefine.hh
• source/persistency/gdml/src/G4GDMLWriteDefine.cc