1 | // |
---|
2 | // ******************************************************************** |
---|
3 | // * License and Disclaimer * |
---|
4 | // * * |
---|
5 | // * The Geant4 software is copyright of the Copyright Holders of * |
---|
6 | // * the Geant4 Collaboration. It is provided under the terms and * |
---|
7 | // * conditions of the Geant4 Software License, included in the file * |
---|
8 | // * LICENSE and available at http://cern.ch/geant4/license . These * |
---|
9 | // * include a list of copyright holders. * |
---|
10 | // * * |
---|
11 | // * Neither the authors of this software system, nor their employing * |
---|
12 | // * institutes,nor the agencies providing financial support for this * |
---|
13 | // * work make any representation or warranty, express or implied, * |
---|
14 | // * regarding this software system or assume any liability for its * |
---|
15 | // * use. Please see the license in the file LICENSE and URL above * |
---|
16 | // * for the full disclaimer and the limitation of liability. * |
---|
17 | // * * |
---|
18 | // * This code implementation is the result of the scientific and * |
---|
19 | // * technical work of the GEANT4 collaboration. * |
---|
20 | // * By using, copying, modifying or distributing the software (or * |
---|
21 | // * any work based on the software) you agree to acknowledge its * |
---|
22 | // * use in resulting scientific publications, and indicate your * |
---|
23 | // * acceptance of all terms of the Geant4 Software license. * |
---|
24 | // ******************************************************************** |
---|
25 | // |
---|
26 | // |
---|
27 | // $Id: G4UImessenger.hh,v 1.9 2006/06/29 19:08:19 gunter Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-03 $ |
---|
29 | // |
---|
30 | |
---|
31 | #ifndef G4UImessenger_h |
---|
32 | #define G4UImessenger_h 1 |
---|
33 | |
---|
34 | #include "globals.hh" |
---|
35 | #include "G4ios.hh" |
---|
36 | |
---|
37 | class G4UIcommand; |
---|
38 | |
---|
39 | // class description: |
---|
40 | // |
---|
41 | // This class is the base class which represents a messenger which maintains |
---|
42 | // the commands. The user who wants to define some commands must create his/her |
---|
43 | // own concrete class derived from this class. The user's concrete messenger |
---|
44 | // must have a responsibility of creating and deleting commands. Also, it must |
---|
45 | // take care the delivering of the command to the destination class and replying |
---|
46 | // the current value(s) of the parameter(s). |
---|
47 | // |
---|
48 | |
---|
49 | class G4UImessenger |
---|
50 | { |
---|
51 | |
---|
52 | public: // with description |
---|
53 | G4UImessenger(); |
---|
54 | // Constructor. In the implementation of the concrete messenger, all commands |
---|
55 | // related to the messenger must be constructed. |
---|
56 | virtual ~G4UImessenger(); |
---|
57 | // Destructor. In the implementation of the concrete messenger, all commands |
---|
58 | // defined in the constructor must be deleted. |
---|
59 | virtual G4String GetCurrentValue(G4UIcommand * command); |
---|
60 | // The concrete implementation of this method gets the current value(s) of the |
---|
61 | // parameter(s) of the given command from the destination class, converts the |
---|
62 | // value(s) to a string, and returns the string. Conversion could be done by |
---|
63 | // the ConvertToString() method of corresponding G4UIcmdXXX classes if the |
---|
64 | // the command is an object of these G4UIcmdXXX classes. |
---|
65 | virtual void SetNewValue(G4UIcommand * command,G4String newValue); |
---|
66 | // The concrete implementation of this method converts the string "newValue" |
---|
67 | // to value(s) of type(s) of the parameter(s). Convert methods corresponding |
---|
68 | // to the type of the command can be used if the command is an object of |
---|
69 | // G4UIcmdXXX classes. |
---|
70 | |
---|
71 | public: |
---|
72 | G4bool operator == (const G4UImessenger& messenger) const; |
---|
73 | |
---|
74 | protected: |
---|
75 | G4String ItoS(G4int i); |
---|
76 | G4String DtoS(G4double a); |
---|
77 | G4String BtoS(G4bool b); |
---|
78 | G4int StoI(G4String s); |
---|
79 | G4double StoD(G4String s); |
---|
80 | G4bool StoB(G4String s); |
---|
81 | |
---|
82 | protected: |
---|
83 | void AddUIcommand(G4UIcommand * newCommand); |
---|
84 | }; |
---|
85 | |
---|
86 | #endif |
---|
87 | |
---|