DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Static Public Member Functions | List of all members
dd4hep::sim::Geant4PythonAction Class Reference

Base class to initialize a multi-threaded or single threaded Geant4 application. More...

#include <Geant4PythonAction.h>

Inheritance diagram for dd4hep::sim::Geant4PythonAction:
dd4hep::sim::Geant4Action

Public Member Functions

 Geant4PythonAction (Geant4Context *ctx, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4PythonAction ()
 Default destructor. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4Action
 Geant4Action (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
long addRef ()
 Increase reference count. More...
 
long release ()
 Decrease reference count. Implicit destruction. More...
 
Geant4Contextcontext () const
 Access the context. More...
 
virtual void updateContext (Geant4Context *ctxt)
 Set or update client context. More...
 
virtual void configureFiber (Geant4Context *thread_context)
 Set or update client for the use in a new thread fiber. More...
 
const std::string & name () const
 Access name of the action. More...
 
const char * c_name () const
 Access name of the action. More...
 
void setName (const std::string &new_name)
 Set the object name. More...
 
PropertyManagerproperties ()
 Access to the properties of the object. More...
 
PrintLevel outputLevel () const
 Access the output level. More...
 
PrintLevel setOutputLevel (PrintLevel new_level)
 Set the output level; returns previous value. More...
 
Geant4UIMessengercontrol () const
 Access to the UI messenger. More...
 
virtual void enableUI ()
 Enable and install UI messenger. More...
 
template<typename T >
Geant4ActiondeclareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
Geant4ActiondeclareProperty (const char *nam, T &val)
 Declare property. More...
 
bool hasProperty (const std::string &name) const
 Check property for existence. More...
 
Propertyproperty (const std::string &name)
 Access single property. More...
 
virtual void installMessengers ()
 Install property control messenger if wanted. More...
 
virtual void installCommandMessenger ()
 Install command control messenger if wanted. More...
 
virtual void installPropertyMessenger ()
 Install property control messenger if wanted. More...
 
void print (const char *fmt,...) const
 Support for messages with variable output level using output level. More...
 
void printM1 (const char *fmt,...) const
 Support for messages with variable output level using output level-1. More...
 
void printM2 (const char *fmt,...) const
 Support for messages with variable output level using output level-2. More...
 
void printP1 (const char *fmt,...) const
 Support for messages with variable output level using output level+1. More...
 
void printP2 (const char *fmt,...) const
 Support for messages with variable output level using output level+2. More...
 
void always (const char *fmt,...) const
 Support of always printed messages. More...
 
void debug (const char *fmt,...) const
 Support of debug messages. More...
 
void info (const char *fmt,...) const
 Support of info messages. More...
 
void warning (const char *fmt,...) const
 Support of warning messages. More...
 
void error (const char *fmt,...) const
 Support of error messages. More...
 
bool return_error (bool return_value, const char *fmt,...) const
 Action to support error messages. More...
 
void fatal (const char *fmt,...) const
 Support of fatal messages. Throws exception. More...
 
void except (const char *fmt,...) const
 Support of exceptions: Print fatal message and throw runtime_error. More...
 
void abortRun (const std::string &exception, const char *fmt,...) const
 Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted. More...
 
Geant4RunActionSequencerunAction () const
 Access to the main run action sequence from the kernel object. More...
 
Geant4EventActionSequenceeventAction () const
 Access to the main event action sequence from the kernel object. More...
 
Geant4SteppingActionSequencesteppingAction () const
 Access to the main stepping action sequence from the kernel object. More...
 
Geant4TrackingActionSequencetrackingAction () const
 Access to the main tracking action sequence from the kernel object. More...
 
Geant4StackingActionSequencestackingAction () const
 Access to the main stacking action sequence from the kernel object. More...
 
Geant4GeneratorActionSequencegeneratorAction () const
 Access to the main generator action sequence from the kernel object. More...
 

Static Public Member Functions

static int call (PyObject *method, PyObject *args)
 Execute command in the python interpreter. More...
 
static int exec (const std::string &cmd)
 Execute command in the python interpreter. More...
 
static int eval (const std::string &cmd)
 Execute command in the python interpreter. More...
 
static int runFile (const std::string &cmd)
 Execute command in the python interpreter. More...
 
static void prompt ()
 Invoke command prompt. More...
 

Additional Inherited Members

- Protected Member Functions inherited from dd4hep::sim::Geant4Action
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Action)
 Define standard assignments and constructors. More...
 
virtual ~Geant4Action ()
 Default destructor. More...
 
- Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Contextm_context { nullptr }
 Reference to the Geant4 context. More...
 
Geant4UIMessengerm_control { nullptr }
 Control directory of this action. More...
 
int m_outputLevel { 3 }
 Default property: Output level. More...
 
bool m_needsControl { false }
 Default property: Flag to create control instance. More...
 
std::string m_name { }
 Action name. More...
 
PropertyManager m_properties { }
 Property pool. More...
 
long m_refCount { 1 }
 Reference count. Initial value: 1. More...
 

Detailed Description

Base class to initialize a multi-threaded or single threaded Geant4 application.

Author
M.Frank
Version
1.0

Definition at line 33 of file Geant4PythonAction.h.

Constructor & Destructor Documentation

◆ Geant4PythonAction()

Geant4PythonAction::Geant4PythonAction ( Geant4Context ctx,
const std::string &  nam 
)

Standard constructor.

Standard constructor, initializes variables.

Definition at line 26 of file Geant4PythonAction.cpp.

◆ ~Geant4PythonAction()

virtual dd4hep::sim::Geant4PythonAction::~Geant4PythonAction ( )
inlinevirtual

Default destructor.

Definition at line 38 of file Geant4PythonAction.h.

Member Function Documentation

◆ call()

int Geant4PythonAction::call ( PyObject *  method,
PyObject *  args 
)
static

Execute command in the python interpreter.

Public class methods

Definition at line 48 of file Geant4PythonAction.cpp.

◆ eval()

int Geant4PythonAction::eval ( const std::string &  cmd)
static

Execute command in the python interpreter.

Definition at line 38 of file Geant4PythonAction.cpp.

◆ exec()

int Geant4PythonAction::exec ( const std::string &  cmd)
static

Execute command in the python interpreter.

Execute command in the python interpreter. Directly forwarded to TPython.

Definition at line 33 of file Geant4PythonAction.cpp.

◆ prompt()

void Geant4PythonAction::prompt ( )
static

Invoke command prompt.

Definition at line 53 of file Geant4PythonAction.cpp.

◆ runFile()

int Geant4PythonAction::runFile ( const std::string &  cmd)
static

Execute command in the python interpreter.

Definition at line 43 of file Geant4PythonAction.cpp.


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