packages/PHGeometry/PHGeomUtility.h

0001 #ifndef PHGEOMETRY_PHGEOMUTILITY_H
0002 #define PHGEOMETRY_PHGEOMUTILITY_H
0003
0004 #include <string>
0005
0006 class PHCompositeNode;
0007 class TGeoManager;
0008 class PHGeomTGeo;
0009 class PHGeomIOTGeo;
0010
0011 //! Toolsets to do geometry operations
0012 class PHGeomUtility
0013 {
0014  public:
0015   //! Main user interface: DST node -> TGeoManager for downstream use
0016   static TGeoManager *
0017   GetTGeoManager(PHCompositeNode *topNode);
0018
0019   //! TGeo ROOT/GDML/Macro file -> DST node with automatic file type discrimination based on file names
0020   static int
0021   ImportGeomFile(PHCompositeNode *topNode, const std::string &geometry_file);
0022
0023   //! gGeoManager -> DST node
0024   static int
0025   ImportCurrentTGeoManager(PHCompositeNode *topNode);
0026
0027   //! DST node -> TGeoManager -> export files, like gdml, .root or .C formats
0028   static void
0029   ExportGeomtry(PHCompositeNode *topNode, const std::string &geometry_file);
0030
0031   //! Get non-persistent PHGeomTGeo from DST nodes. If not found, make a new one
0032   static PHGeomTGeo *
0033   GetGeomTGeoNode(PHCompositeNode *topNode, bool build_new = true);
0034
0035   //! Get persistent PHGeomIOTGeo from DST nodes. If not found, make a new one
0036   static PHGeomIOTGeo *
0037   GetGeomIOTGeoNode(PHCompositeNode *topNode, bool build_new = true);
0038
0039   //! Update persistent PHGeomIOTGeo node RUN/GEOMETRY_IO based on run-time object PHGeomTGeo at RUN/GEOMETRY
0040   //! \return the updated PHGeomIOTGeo from DST tree
0041   static PHGeomIOTGeo *
0042   UpdateIONode(PHCompositeNode *topNode);
0043
0044   //! Build or update PHGeomTGeo node RUN/GEOMETRY based on the persistent PHGeomIOTGeo node RUN/GEOMETRY_IO
0045   //! \return the updated PHGeomTGeo from DST tree
0046   static PHGeomTGeo *
0047   LoadFromIONode(PHCompositeNode *topNode);
0048
0049   //! Make a name for tmp geometry file
0050   //! Geometry files gain a size of ~10MB and it used in translation from Geant4 to DST format.
0051   //! This tmp file should be on a local file system (/tmp/) and write/deletable
0052   static std::string
0053   GenerateGeometryFileName(const std::string &filename_extension = "gdml");
0054
0055   //! delete the geometry file after use
0056   static bool
0057   RemoveGeometryFile(const std::string &file_name);
0058
0059   //! Verbosity for geometry IO like, TGeoMangers
0060   static void SetVerbosity(int v);
0061
0062   //! Verbosity for geometry IO like, TGeoMangers
0063   static int GetVerbosity();
0064
0065   //! DST node name for RunTime geometry object
0066   static std::string
0067   GetDSTNodeName()
0068   {
0069     return std::string("GEOMETRY");
0070   }
0071
0072   //! DST node name for persistent geometry storage node
0073   static std::string
0074   GetDSTIONodeName()
0075   {
0076     return std::string("GEOMETRY_IO");
0077   }
0078
0079   //! Base path name for temp geometry GDML file used in GenerateGeometryFileName().
0080   //! User can overwrite it to e.g. local directory with  PHGeomUtility::SetGenerateGeometryFileNameBase('./');
0081   static void SetGenerateGeometryFileNameBase(const std::string &base) { mg_GenerateGeometryFileNameBase = base; }
0082
0083  private:
0084   PHGeomUtility() = delete;
0085   ~PHGeomUtility() = delete;
0086
0087   //! Base path name for temp geometry GDML file used in GenerateGeometryFileName().
0088   //! User can overwrite it to e.g. local directory with  PHGeomUtility::SetGenerateGeometryFileNameBase('./');
0089   static std::string mg_GenerateGeometryFileNameBase;
0090 };
0091
0092 #endif