include/Geant4/G4tgrPlaceParameterisation.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 // G4tgrPlaceParameterisation
0027 //
0028 // Class description:
0029 //
0030 // Class to descripe the positioning of a G4tgrVolume inside another
0031 // G4tgrVolume as a parameterised volume. Several types are possible:
0032 // - Parameterisation of the position and rotation for each copy
0033 // - Parameterisation also of the dimensions
0034 // - Parameterisation of the solid type
0035 // Data is just stored in this class, without any calculation of the
0036 // positions of each copy
0037 // :POS_PARAM "volu_name" copyNo "parent_name" "parametrisation_type"
0038 //            number_copies step offset extra_data(n words).
0039
0040 // Author: P.Arce, CIEMAT (November 2007)
0041 // --------------------------------------------------------------------
0042 #ifndef G4tgrPlaceParameterisation_hh
0043 #define G4tgrPlaceParameterisation_hh 1
0044
0045 #include <vector>
0046
0047 #include "globals.hh"
0048 #include "G4tgrPlace.hh"
0049
0050 class G4tgrPlaceParameterisation : public G4tgrPlace
0051 {
0052   public:
0053
0054     G4tgrPlaceParameterisation();
0055     ~G4tgrPlaceParameterisation();
0056
0057     G4tgrPlaceParameterisation(const std::vector<G4String>& p);
0058       // Creates an object passing the parameters
0059
0060     // Access functions
0061
0062     const G4String& GetParamType() const { return theParamType; }
0063       // GetType returns placement type
0064     std::vector<G4double> GetExtraData() const { return theExtraData; }
0065     const G4String& GetRotMatName() const { return theRotMatName; }
0066
0067     friend std::ostream& operator<<(std::ostream& os,
0068                                     const G4tgrPlaceParameterisation& obj);
0069
0070   private:
0071
0072     G4String theParamType;
0073     std::vector<G4double> theExtraData;
0074       // Extra data not common to all parameterisations
0075
0076     G4String theRotMatName;
0077       // The rotation matrix (by name, as the rotations
0078       // matrices are not yet created)
0079 };
0080
0081 #endif