moleculardna/include/DNAGeometryMessenger.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 //
0027 /// \file DNAGeometryMessenger.hh
0028
0029 #ifndef MOLECULAR_DNA_MESSENGER_HH
0030 #define MOLECULAR_DNA_MESSENGER_HH
0031
0032 #include "G4UIcmdWith3VectorAndUnit.hh"
0033 #include "G4UIcmdWithABool.hh"
0034 #include "G4UIcmdWithADouble.hh"
0035 #include "G4UIcmdWithADoubleAndUnit.hh"
0036 #include "G4UIcmdWithAString.hh"
0037 #include "G4UIcmdWithAnInteger.hh"
0038 #include "G4UIcmdWithoutParameter.hh"
0039 #include "G4UIdirectory.hh"
0040 #include "G4UImessenger.hh"
0041 #include "globals.hh"
0042
0043 #include <memory>
0044
0045 class DNAGeometry;
0046
0047 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0048
0049 class DNAGeometryMessenger : public G4UImessenger
0050 {
0051   public:
0052     explicit DNAGeometryMessenger(DNAGeometry*);
0053
0054     ~DNAGeometryMessenger() override = default;
0055
0056     void SetNewValue(G4UIcommand*, G4String) override;
0057
0058   protected:
0059   private:
0060     DNAGeometry* fpDNAGeometry;
0061
0062     // Related to "voxel" placements
0063     std::unique_ptr<G4UIdirectory> fpDNADirectory;
0064     std::unique_ptr<G4UIcmdWithAString> fpNewPlacementVolumeFile;  // specifies molecule locations
0065     std::unique_ptr<G4UIcmdWithAString> fpVoxelPlacementsFile;  // specifies voxel locations
0066     std::unique_ptr<G4UIcmdWith3VectorAndUnit> fpVoxelSideLength;  // voxel size
0067     std::unique_ptr<G4UIcmdWith3VectorAndUnit>
0068       fpFractalScaling;  // multiplier for de-dimensionalised voxel locations
0069     std::unique_ptr<G4UIcmdWithABool>
0070       fpAnglesAsPi;  // take voxel placement angles as multiples of pi
0071     std::unique_ptr<G4UIcmdWithABool>
0072       fpCustomMoleculeSizes;  // turn off default molecule sizes and use custom
0073     std::unique_ptr<G4UIcmdWithAString> fpAddMoleculeSize;  // set a molecule size
0074
0075     // Related to processing
0076     std::unique_ptr<G4UIcmdWithABool> fpCheckDNAOverlaps;
0077     std::unique_ptr<G4UIcmdWithAnInteger> fpVerbosity;
0078     std::unique_ptr<G4UIcmdWithAnInteger> fpSmartless;
0079
0080     // damage-like
0081     std::unique_ptr<G4UIcmdWithADoubleAndUnit> fpIntRangeDirect;
0082     std::unique_ptr<G4UIcmdWithADoubleAndUnit> fpRadicalKillDistance;
0083     std::unique_ptr<G4UIcmdWithABool> fpUseHistoneScav;
0084
0085     // vis
0086     std::unique_ptr<G4UIcmdWithABool> fpDrawCellVolumes;
0087     // testing
0088     std::unique_ptr<G4UIdirectory> fpTestDirectory;
0089     std::unique_ptr<G4UIcmdWithoutParameter> fpChromosomeTest;
0090     std::unique_ptr<G4UIcmdWithoutParameter> fpBasePairTest;
0091     std::unique_ptr<G4UIcmdWithoutParameter> fpUniqueIDTest;
0092 };
0093
0094 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0095
0096 #endif  // MOLECULAR_DNA_MESSENGER_HH