Geant4_10
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
source
source
intercoms
include
G4UIcmdWith3Vector.hh
Go to the documentation of this file.
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: G4UIcmdWith3Vector.hh 67965 2013-03-13 09:35:29Z gcosmo $
28
//
29
//
30
31
#ifndef G4UIcmdWith3Vector_H
32
#define G4UIcmdWith3Vector_H 1
33
34
#include "
G4UIcommand.hh
"
35
#include "
G4ThreeVector.hh
"
36
37
// class description:
38
// A concrete class of G4UIcommand. The command defined by this class
39
// takes three double values.
40
// General information of G4UIcommand is given in G4UIcommand.hh.
41
42
class
G4UIcmdWith3Vector
:
public
G4UIcommand
43
{
44
public
:
// with description
45
G4UIcmdWith3Vector
46
(
const
char
* theCommandPath,
G4UImessenger
* theMessenger);
47
// Constructor. The command string with full path directory
48
// and the pointer to the messenger must be given.
49
static
G4ThreeVector
GetNew3VectorValue
(
const
char
* paramString);
50
// Convert string which represents three double values to
51
// G4ThreeVector.
52
void
SetParameterName
(
const
char
* theNameX,
const
char
* theNameY,
53
const
char
* theNameZ,
G4bool
omittable,
G4bool
currentAsDefault=
false
);
54
// Set the parameter names for three parameters. Names are used by
55
// the range checking routine.
56
// If "omittable" is set as true, the user of this command can ommit
57
// the value(s) when he/she applies the command. If "omittable" is false,
58
// the user must supply all three values.
59
// "currentAsDefault" flag is valid only if "omittable" is true. If this
60
// flag is true, the current values are used as the default values when the
61
// user ommit some of the parameters. If this flag is false, the values
62
// given by the next SetDefaultValue() method are used.
63
void
SetDefaultValue
(
G4ThreeVector
defVal);
64
// Set the default values of the parameters. These default values are used
65
// when the user of this command ommits some of the parameter values, and
66
// "ommitable" is true and "currentAsDefault" is false.
67
};
68
69
#endif
CLHEP::Hep3Vector
Definition:
ThreeVector.h:41
G4UIcmdWith3Vector::G4UIcmdWith3Vector
G4UIcmdWith3Vector(const char *theCommandPath, G4UImessenger *theMessenger)
Definition:
G4UIcmdWith3Vector.cc:34
G4UIcmdWith3Vector::SetParameterName
void SetParameterName(const char *theNameX, const char *theNameY, const char *theNameZ, G4bool omittable, G4bool currentAsDefault=false)
Definition:
G4UIcmdWith3Vector.cc:51
G4UIcommand
Definition:
G4UIcommand.hh:51
G4UIcmdWith3Vector::GetNew3VectorValue
static G4ThreeVector GetNew3VectorValue(const char *paramString)
Definition:
G4UIcmdWith3Vector.cc:45
G4UIcommand.hh
G4bool
bool G4bool
Definition:
G4Types.hh:79
G4UIcmdWith3Vector
Definition:
G4UIcmdWith3Vector.hh:42
G4UImessenger
Definition:
G4UImessenger.hh:47
G4ThreeVector.hh
G4UIcmdWith3Vector::SetDefaultValue
void SetDefaultValue(G4ThreeVector defVal)
Definition:
G4UIcmdWith3Vector.cc:68
Generated on Sat Dec 14 2013 14:34:16 for Geant4_10 by
1.8.5