include/Geant4/G4VReadOutGeometry.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 //
0028 // ------------------------------------------------------------
0029
0030 #ifndef G4VReadOutGeometry_h
0031 #define G4VReadOutGeometry_h
0032
0033 #include "G4SensitiveVolumeList.hh"
0034 #include "G4Step.hh"
0035 #include "G4TouchableHistory.hh"
0036
0037 class G4Navigator;
0038
0039 class G4VReadOutGeometry
0040 {
0041  public:
0042   G4VReadOutGeometry();
0043   G4VReadOutGeometry(G4String);
0044   virtual ~G4VReadOutGeometry();
0045
0046   G4bool operator==(const G4VReadOutGeometry& right) const;
0047   G4bool operator!=(const G4VReadOutGeometry& right) const;
0048
0049   // buildROGeomety must be invoked to Build (ie Build() method)
0050   // the ROGeometry. It sets up in addition the needed
0051   // the G4Navigator used to navigate inside this ROGeometry.
0052   void BuildROGeometry();
0053   virtual G4bool CheckROVolume(G4Step*, G4TouchableHistory*&);
0054
0055   inline const G4SensitiveVolumeList* GetIncludeList() const { return fincludeList; }
0056   inline void SetIncludeList(G4SensitiveVolumeList* value) { fincludeList = value; }
0057   inline const G4SensitiveVolumeList* GetExcludeList() const { return fexcludeList; }
0058   inline void SetExcludeList(G4SensitiveVolumeList* value) { fexcludeList = value; }
0059   inline G4String GetName() const { return name; }
0060   inline void SetName(G4String value) { name = value; }
0061   // ADDED:
0062   inline G4VPhysicalVolume* GetROWorld() const { return ROworld; }
0063
0064  protected:
0065   virtual G4VPhysicalVolume* Build() = 0;  // must return the world of the ROGeometry;
0066
0067   G4VReadOutGeometry(const G4VReadOutGeometry& right);
0068   G4VReadOutGeometry& operator=(const G4VReadOutGeometry& right);
0069
0070   virtual G4bool FindROTouchable(G4Step*);
0071
0072  protected:
0073   G4VPhysicalVolume* ROworld;
0074   G4SensitiveVolumeList* fincludeList;
0075   G4SensitiveVolumeList* fexcludeList;
0076   G4String name;
0077
0078   G4Navigator* ROnavigator;
0079   G4TouchableHistory* touchableHistory;
0080 };
0081
0082 #endif