Geant4 9.6.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
HEPREP::HepRepFactory Class Referenceabstract

#include <HepRepFactory.h>

+ Inheritance diagram for HEPREP::HepRepFactory:

Public Member Functions

virtual ~HepRepFactory ()
 Destructor.
 
virtual HepRepReadercreateHepRepReader (std::istream *in)=0
 
virtual HepRepReadercreateHepRepReader (std::string inputFileName)=0
 
virtual HepRepWritercreateHepRepWriter (std::ostream *out, bool randomAccess, bool compress)=0
 
virtual HepRepPointcreateHepRepPoint (HepRepInstance *instance, double x, double y, double z)=0
 
virtual HepRepInstancecreateHepRepInstance (HepRepInstance *parent, HepRepType *type)=0
 
virtual HepRepInstancecreateHepRepInstance (HepRepInstanceTree *parent, HepRepType *type)=0
 
virtual HepRepTreeIDcreateHepRepTreeID (std::string name, std::string version, std::string qualifier="top-level")=0
 
virtual HepRepActioncreateHepRepAction (std::string name, std::string expression)=0
 
virtual HepRepInstanceTreecreateHepRepInstanceTree (std::string name, std::string version, HepRepTreeID *typeTree)=0
 
virtual HepRepTypecreateHepRepType (HepRepTypeTree *parent, std::string name)=0
 
virtual HepRepTypecreateHepRepType (HepRepType *parent, std::string name)=0
 
virtual HepRepTypeTreecreateHepRepTypeTree (HepRepTreeID *treeID)=0
 
virtual HepRepcreateHepRep ()=0
 

Detailed Description

HepRepFactory interface.

Author
Mark Donszelmann

Definition at line 33 of file HepRepFactory.h.

Constructor & Destructor Documentation

◆ ~HepRepFactory()

virtual HEPREP::HepRepFactory::~HepRepFactory ( )
inlinevirtual

Destructor.

Definition at line 37 of file HepRepFactory.h.

37{ /* nop */; }

Member Function Documentation

◆ createHepRep()

virtual HepRep * HEPREP::HepRepFactory::createHepRep ( )
pure virtual

Creates a HepRep.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepAction()

virtual HepRepAction * HEPREP::HepRepFactory::createHepRepAction ( std::string  name,
std::string  expression 
)
pure virtual

Creates a HepRepAction.

Parameters
nameof the action.
expressionof the action.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepInstance() [1/2]

virtual HepRepInstance * HEPREP::HepRepFactory::createHepRepInstance ( HepRepInstance parent,
HepRepType type 
)
pure virtual

Creates a HepRepInstance.

@parent to add the instance to. @type type the associated type.

Implemented in cheprep::DefaultHepRepFactory.

Referenced by G4HepRepSceneHandler::AddPrimitive(), and G4HepRepSceneHandler::AddSolid().

◆ createHepRepInstance() [2/2]

virtual HepRepInstance * HEPREP::HepRepFactory::createHepRepInstance ( HepRepInstanceTree parent,
HepRepType type 
)
pure virtual

Creates a HepRepInstance.

@parent to add the instance to. @type type the associated type.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepInstanceTree()

virtual HepRepInstanceTree * HEPREP::HepRepFactory::createHepRepInstanceTree ( std::string  name,
std::string  version,
HepRepTreeID typeTree 
)
pure virtual

Creates a HepRepInstanceTree.

The tree needs to be added to the HepRep.

Parameters
nameof the instancetree.
versionof the instancetree.
typeTreeassociated typetree.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepPoint()

virtual HepRepPoint * HEPREP::HepRepFactory::createHepRepPoint ( HepRepInstance instance,
double  x,
double  y,
double  z 
)
pure virtual

Creates a HepRepPoint.

Parameters
instanceto add the point to.
xx coordinate of point.
yy coordinate of point.
zz coordinate of point.

Implemented in cheprep::DefaultHepRepFactory.

Referenced by G4HepRepSceneHandler::AddPrimitive(), and G4HepRepSceneHandler::AddSolid().

◆ createHepRepReader() [1/2]

virtual HepRepReader * HEPREP::HepRepFactory::createHepRepReader ( std::istream *  in)
pure virtual

Creates a HepRepReader from a stream.

Parameters
ininput stream.

Implemented in cheprep::DefaultHepRepFactory, and cheprep::XMLHepRepFactory.

◆ createHepRepReader() [2/2]

virtual HepRepReader * HEPREP::HepRepFactory::createHepRepReader ( std::string  inputFileName)
pure virtual

Creates a HepRepReader from a file name.

Parameters
inputFileNamefile name.

Implemented in cheprep::DefaultHepRepFactory, and cheprep::XMLHepRepFactory.

◆ createHepRepTreeID()

virtual HepRepTreeID * HEPREP::HepRepFactory::createHepRepTreeID ( std::string  name,
std::string  version,
std::string  qualifier = "top-level" 
)
pure virtual

Creates a HepRepTreeID.

Parameters
nameof the treeID.
versionof the treeID.
qualifierof the treeID.

Implemented in cheprep::DefaultHepRepFactory.

Referenced by G4HepRepSceneHandler::closeHepRep().

◆ createHepRepType() [1/2]

virtual HepRepType * HEPREP::HepRepFactory::createHepRepType ( HepRepType parent,
std::string  name 
)
pure virtual

Creates a HepRepType.

Parameters
parentto add this type to.
nameof the type to create.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepType() [2/2]

virtual HepRepType * HEPREP::HepRepFactory::createHepRepType ( HepRepTypeTree parent,
std::string  name 
)
pure virtual

Creates a HepRepType.

Parameters
parentto add this type to.
nameof the type to create.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepTypeTree()

virtual HepRepTypeTree * HEPREP::HepRepFactory::createHepRepTypeTree ( HepRepTreeID treeID)
pure virtual

Creates a HepRepTypeTree.

The tree needs to be added to the HepRep.

Parameters
treeIDto name the tree being created.

Implemented in cheprep::DefaultHepRepFactory.

◆ createHepRepWriter()

virtual HepRepWriter * HEPREP::HepRepFactory::createHepRepWriter ( std::ostream *  out,
bool  randomAccess,
bool  compress 
)
pure virtual

Creates a HepRepWriter.

Parameters
outoutput stream.
randomAccesscreate a writer in a format that will allow random access (may be ignored).
compresscreate a writer that uses compression (may be ignored).

Implemented in cheprep::DefaultHepRepFactory, and cheprep::XMLHepRepFactory.

Referenced by G4HepRepSceneHandler::openFile().


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