include/Geant4/G4VVolumeMaterialScanner.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 // G4VVolumeMaterialScanner
0027 //
0028 // Class description:
0029 //
0030 // Interface for repeated volumes or parameterisations that are able to
0031 // tabulate their materials.
0032
0033 // Author: John Apostolakis (CERN), 18.11.2005
0034 // --------------------------------------------------------------------
0035 #ifndef G4VVOLUMEMATERIALSCANNER_HH
0036 #define G4VVOLUMEMATERIALSCANNER_HH
0037
0038 #include "G4Types.hh"
0039
0040 class G4Material;
0041
0042 /**
0043  * @brief G4VVolumeMaterialScanner is an interface class for repeated volumes
0044  * or parameterisations that are able to tabulate their materials.
0045  */
0046
0047 class G4VVolumeMaterialScanner
0048 {
0049   public:
0050
0051     /**
0052      * Default Constructor and Destructor.
0053      */
0054     G4VVolumeMaterialScanner() = default;
0055     virtual ~G4VVolumeMaterialScanner() = default;
0056
0057     /**
0058      * Method to return the total number of materials.
0059      */
0060     virtual G4int GetNumberOfMaterials() const = 0;
0061
0062     /**
0063      * Method to return a pointer to the material, given an index.
0064      */
0065     virtual G4Material* GetMaterial(G4int idx) const = 0;
0066 };
0067
0068 #endif