include/Geant4/G4UIbridge.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4UIbridge
0027 //
0028 // Class description:
0029 //
0030 // This class is to be used for MT mode.
0031 // Register a particular thread-local G4UImanager with a UI command
0032 // directory name. When a UI command is issued in the master thread
0033 // that starts with this registered directory name, it is immediately
0034 // forwarded to the registered G4UImanager. Such forwarded command
0035 // is not processed in the master thread nor by other worker thread
0036
0037 // Author: A.Dotti, 2013
0038 // --------------------------------------------------------------------
0039 #ifndef G4UIbridge_hh
0040 #define G4UIbridge_hh 1
0041
0042 #include "globals.hh"
0043
0044 class G4UImanager;
0045
0046 class G4UIbridge
0047 {
0048   public:
0049     G4UIbridge(G4UImanager* localUI, G4String dir);
0050     ~G4UIbridge() = default;
0051
0052     G4int ApplyCommand(const G4String& aCmd);
0053
0054     inline G4UImanager* LocalUI() const { return localUImanager; }
0055     inline const G4String& DirName() const { return dirName; }
0056     inline G4int DirLength() const { return (G4int)dirName.length(); }
0057
0058   private:
0059     G4UImanager* localUImanager = nullptr;
0060     G4String dirName;
0061 };
0062
0063 #endif