| Geant4 Cross Reference |
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 // G4LocalThreadCoutMessenger
27 //
28 // Author: M.Asai, 2013
29 // --------------------------------------------------------------------
30
31 #include "G4LocalThreadCoutMessenger.hh"
32
33 #include "G4Tokenizer.hh"
34 #include "G4UIcmdWithABool.hh"
35 #include "G4UIcmdWithAString.hh"
36 #include "G4UIcmdWithAnInteger.hh"
37 #include "G4UIcommand.hh"
38 #include "G4UIdirectory.hh"
39 #include "G4UImanager.hh"
40 #include "G4UIparameter.hh"
41
42 // --------------------------------------------------------------------
43 G4LocalThreadCoutMessenger::G4LocalThreadCoutMessenger()
44 {
45 coutDir = new G4UIdirectory("/control/cout/");
46 coutDir->SetGuidance("Control cout/cerr for local thread.");
47
48 coutFileNameCmd = new G4UIcommand("/control/cout/setCoutFile", this);
49 coutFileNameCmd->SetGuidance("Send G4cout stream to a file dedicated to a thread. ");
50 coutFileNameCmd->SetGuidance("To have a display output, use special keyword \"**Screen**\".");
51 coutFileNameCmd->SetGuidance("If append flag is true output is appended to file,");
52 coutFileNameCmd->SetGuidance("otherwise file output is overwritten.");
53 coutFileNameCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
54 auto* pp = new G4UIparameter("fileName", 's', true);
55 pp->SetDefaultValue("**Screen**");
56 coutFileNameCmd->SetParameter(pp);
57 pp = new G4UIparameter("append", 'b', true);
58 pp->SetDefaultValue(1);
59 coutFileNameCmd->SetParameter(pp);
60
61 cerrFileNameCmd = new G4UIcommand("/control/cout/setCerrFile", this);
62 cerrFileNameCmd->SetGuidance("Send G4cerr stream to a file dedicated to a thread. ");
63 cerrFileNameCmd->SetGuidance("To have a display output, use special keyword \"**Screen**\".");
64 cerrFileNameCmd->SetGuidance("If append flag is true output is appended to file,");
65 cerrFileNameCmd->SetGuidance("otherwise file output is overwritten.");
66 cerrFileNameCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
67 pp = new G4UIparameter("fileName", 's', true);
68 pp->SetDefaultValue("**Screen**");
69 cerrFileNameCmd->SetParameter(pp);
70 pp = new G4UIparameter("append", 'b', true);
71 pp->SetDefaultValue(1);
72 cerrFileNameCmd->SetParameter(pp);
73
74 bufferCoutCmd = new G4UIcmdWithABool("/control/cout/useBuffer", this);
75 bufferCoutCmd->SetGuidance("Send cout and/or cerr stream to a buffer.");
76 bufferCoutCmd->SetGuidance("The buffered text will be printed at the end of the job");
77 bufferCoutCmd->SetGuidance(
78 "for each thread at a time, so that output of each thread is grouped.");
79 bufferCoutCmd->SetGuidance("This command has no effect if output goes to a file.");
80 bufferCoutCmd->SetParameterName("flag", true);
81 bufferCoutCmd->SetDefaultValue(true);
82 bufferCoutCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
83
84 prefixCmd = new G4UIcmdWithAString("/control/cout/prefixString", this);
85 prefixCmd->SetGuidance("Set the prefix string for each cout/cerr line from a thread.");
86 prefixCmd->SetParameterName("prefix", true);
87 prefixCmd->SetDefaultValue("G4WT");
88 prefixCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
89
90 ignoreCmd = new G4UIcmdWithAnInteger("/control/cout/ignoreThreadsExcept", this);
91 ignoreCmd->SetGuidance("Omit cout from threads except the specified one.");
92 ignoreCmd->SetGuidance(
93 "This command takes effect only if cout destination "
94 "is screen without buffering.");
95 ignoreCmd->SetGuidance("If specified thread ID is greater than the number of threads,");
96 ignoreCmd->SetGuidance("no cout is displayed from worker threads. -1 to reset.");
97 ignoreCmd->SetGuidance("This command does not affect to cerr.");
98 ignoreCmd->SetParameterName("threadID", true);
99 ignoreCmd->SetDefaultValue(0);
100 ignoreCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
101
102 ignoreInitCmd = new G4UIcmdWithABool("/control/cout/ignoreInitializationCout", this);
103 ignoreInitCmd->SetGuidance(
104 "Omit cout from threads during initialization, as "
105 "they should be identical to the master thread.");
106 ignoreInitCmd->SetGuidance(
107 "This command takes effect only if cout "
108 "destination is screen without buffering.");
109 ignoreInitCmd->SetGuidance("This command does not affect to cerr.");
110 ignoreInitCmd->SetParameterName("IgnoreInit", true);
111 ignoreInitCmd->SetDefaultValue(true);
112 ignoreInitCmd->AvailableForStates(G4State_PreInit, G4State_Idle);
113 }
114
115 // --------------------------------------------------------------------
116 G4LocalThreadCoutMessenger::~G4LocalThreadCoutMessenger()
117 {
118 delete coutFileNameCmd;
119 delete cerrFileNameCmd;
120 delete bufferCoutCmd;
121 delete prefixCmd;
122 delete ignoreCmd;
123 delete ignoreInitCmd;
124 delete coutDir;
125 }
126
127 // --------------------------------------------------------------------
128 void G4LocalThreadCoutMessenger::SetNewValue(G4UIcommand* command, G4String newVal)
129 {
130 G4UImanager* UI = G4UImanager::GetUIpointer();
131 if (command == coutFileNameCmd) {
132 G4Tokenizer next(newVal);
133 G4String fn = next();
134 G4bool af = StoB(next());
135 UI->SetCoutFileName(fn, af);
136 }
137 else if (command == cerrFileNameCmd) {
138 G4Tokenizer next(newVal);
139 G4String fn = next();
140 G4bool af = StoB(next());
141 UI->SetCerrFileName(fn, af);
142 }
143 else if (command == bufferCoutCmd) {
144 UI->SetThreadUseBuffer(StoB(newVal));
145 }
146 else if (command == prefixCmd) {
147 UI->SetThreadPrefixString(newVal);
148 }
149 else if (command == ignoreCmd) {
150 UI->SetThreadIgnore(StoI(newVal));
151 }
152 else if (command == ignoreInitCmd) {
153 UI->SetThreadIgnoreInit(StoB(newVal));
154 }
155 }
156