Files
geant4/source/persistency/gdml/include/G4GDMLWrite.hh
T
2021-06-14 10:01:31 +02:00

141 lines
5.2 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
// G4GDMLWrite
//
// Class description:
//
// GDML writer.
// Author: Zoltan Torzsok, November 2007
// --------------------------------------------------------------------
#ifndef G4GDMLWRITE_HH
#define G4GDMLWRITE_HH 1
#include <map>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/util/XMLString.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/framework/LocalFileFormatTarget.hpp>
#include "G4Transform3D.hh"
#include "G4GDMLAuxStructType.hh"
class G4LogicalVolume;
class G4VPhysicalVolume;
class G4GDMLWrite
{
using VolumeMapType = std::map<const G4LogicalVolume*, G4Transform3D>;
using PhysVolumeMapType = std::map<const G4VPhysicalVolume*, G4String>;
using DepthMapType = std::map<G4int, G4int>;
public:
G4Transform3D Write(const G4String& filename,
const G4LogicalVolume* const topLog,
const G4String& schemaPath, const G4int depth,
G4bool storeReferences = true);
//
// Main method for writing GDML files.
void AddModule(const G4VPhysicalVolume* const topVol);
void AddModule(const G4int depth);
//
// Split geometry structure in modules, by volume subtree or level.
void AddAuxiliary(G4GDMLAuxStructType myaux);
//
// Import auxiliary structure.
void SetOutputFileOverwrite(G4bool flag);
//
// Set the flag to allow overwriting of the output GDML file
static void SetAddPointerToName(G4bool);
//
// Specify if to add or not memory addresses to IDs.
virtual void DefineWrite(xercesc::DOMElement*) = 0;
virtual void MaterialsWrite(xercesc::DOMElement*) = 0;
virtual void SolidsWrite(xercesc::DOMElement*) = 0;
virtual void StructureWrite(xercesc::DOMElement*) = 0;
virtual G4Transform3D TraverseVolumeTree(const G4LogicalVolume* const,
const G4int) = 0;
virtual void SurfacesWrite() = 0;
virtual void SetupWrite(xercesc::DOMElement*,
const G4LogicalVolume* const) = 0;
//
// Pure virtual methods implemented in concrete writer plugin's classes.
virtual void ExtensionWrite(xercesc::DOMElement*);
virtual void UserinfoWrite(xercesc::DOMElement*);
virtual void AddExtension(xercesc::DOMElement*,
const G4LogicalVolume* const);
//
// To be implemented in the client code for handling extensions
// to the GDML schema, identified with the tag "extension".
// The implementation should be placed inside a user-class
// inheriting from G4GDMLWriteStructure and being registered
// as argument to G4GDMLParser.
G4String GenerateName(const G4String&, const void* const);
protected:
G4GDMLWrite();
virtual ~G4GDMLWrite();
VolumeMapType& VolumeMap();
xercesc::DOMAttr* NewAttribute(const G4String&, const G4String&);
xercesc::DOMAttr* NewAttribute(const G4String&, const G4double&);
xercesc::DOMElement* NewElement(const G4String&);
G4String Modularize(const G4VPhysicalVolume* const topvol,
const G4int depth);
void AddAuxInfo(G4GDMLAuxListType* auxInfoList,
xercesc::DOMElement* element);
G4bool FileExists(const G4String&) const;
PhysVolumeMapType& PvolumeMap();
DepthMapType& DepthMap();
protected:
G4String SchemaLocation;
static G4bool addPointerToName;
xercesc::DOMDocument* doc = nullptr;
xercesc::DOMElement* extElement = nullptr;
xercesc::DOMElement* userinfoElement = nullptr;
G4GDMLAuxListType auxList;
G4bool overwriteOutputFile = false;
};
#endif