include/Geant4/G4FieldSetupMessenger.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 /// \file G4FieldSetupMessenger.h
0027 /// \brief Definition of the G4FieldSetupMessenger class
0028 ///
0029 /// \author I. Hrivnacova; IJCLab, Orsay
0030
0031 #ifndef G4FIELDSETUPMESSENGER_HH
0032 #define G4FIELDSETUPMESSENGER_HH
0033
0034 #include "G4UImessenger.hh"
0035 #include "globals.hh"
0036
0037 class G4FieldSetup;
0038
0039 class G4UIcommand;
0040 class G4UIdirectory;
0041 class G4UIcmdWithoutParameter;
0042 class G4UIcmdWithAnInteger;
0043
0044 /// \ingroup geometry
0045 /// \brief Messenger class that defines commands for G4FieldSetup
0046 ///
0047 /// Implements commands:
0048 /// - /field/update
0049 ///
0050 /// \author I. Hrivnacova; IJCLab, Orsay
0051
0052 class G4FieldSetupMessenger : public G4UImessenger
0053 {
0054  public:
0055   /// Standard constructor
0056   G4FieldSetupMessenger(G4FieldSetup* fieldSetup);
0057   /// Destructor
0058   ~G4FieldSetupMessenger() override;
0059
0060   // methods
0061   /// Apply command to the associated object.
0062   void SetNewValue(G4UIcommand* command, G4String newValues) override;
0063
0064  private:
0065   /// Not implemented
0066   G4FieldSetupMessenger() = delete;
0067   /// Not implemented
0068   G4FieldSetupMessenger(const G4FieldSetupMessenger& right) = delete;
0069   /// Not implemented
0070   G4FieldSetupMessenger& operator=(const G4FieldSetupMessenger& right) = delete;
0071
0072   // data members
0073   G4FieldSetup* fFieldSetup = nullptr; ///< associated class
0074
0075   //
0076   // commands data members
0077
0078   /// Command: update
0079   G4UIcmdWithoutParameter* fUpdateCmd = nullptr;
0080 };
0081
0082 #endif // G4FIELDBUILDERMESSENGER_HH