Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/intercoms/include/G4UIcmdWith3Vector.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ] 

  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 // G4UIcmdWith3Vector
 27 //
 28 // Class description:
 29 //
 30 // A concrete class of G4UIcommand. The command defined by this class
 31 // takes three double values.
 32 // General information of G4UIcommand is given in G4UIcommand.hh
 33 
 34 // Author: M.Asai, 1998
 35 // --------------------------------------------------------------------
 36 #ifndef G4UIcmdWith3Vector_hh
 37 #define G4UIcmdWith3Vector_hh 1
 38 
 39 #include "G4ThreeVector.hh"
 40 #include "G4UIcommand.hh"
 41 
 42 class G4UIcmdWith3Vector : public G4UIcommand
 43 {
 44   public:
 45     // Constructor. The command string with full path directory
 46     // and the pointer to the messenger must be given
 47     G4UIcmdWith3Vector(const char* theCommandPath, G4UImessenger* theMessenger);
 48 
 49     // Set the parameter names for three parameters. Names are used by
 50     // the range checking function.
 51     // If "omittable" is set as true, the user of this command can omit
 52     // the value(s) when the command is applied. If "omittable" is false,
 53     // the user must supply all three values.
 54     // "currentAsDefault" flag is valid only if "omittable" is true. If this
 55     // flag is true, the current values are used as the default values when
 56     // the user omits some of the parameters. If this flag is false, the
 57     // values given by the next SetDefaultValue() method are used
 58     void SetParameterName(const char* theNameX, const char* theNameY, const char* theNameZ,
 59                           G4bool omittable, G4bool currentAsDefault = false);
 60 
 61     // Set the default values of the parameters. These default values are
 62     // used when the user of this command omits some of the parameter values,
 63     // and "omittable" is true and "currentAsDefault" is false
 64     void SetDefaultValue(const G4ThreeVector& defVal);
 65 
 66     // Convert string which represents three double values to G4ThreeVector
 67     static G4ThreeVector GetNew3VectorValue(const char* paramString);
 68 };
 69 
 70 #endif
 71