include/Geant4/G4VModelFactory.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 // Jane Tinslay, John Allison, Joseph Perl October 2005
0028 //
0029 // Class Description:
0030 // Abstract base class for model factories. Derived classes
0031 // must implement the Create method, creating a new model
0032 // and associated messengers.
0033 // Class Description - End:
0034
0035 #ifndef G4VMODELFACTORY
0036 #define G4VMODELFACTORY
0037
0038 #include "G4String.hh"
0039 #include <iostream>
0040 #include <utility>
0041 #include <vector>
0042
0043 class G4UImessenger;
0044
0045 template <class T>
0046 class G4VModelFactory {
0047
0048 public: // With description
0049
0050   typedef std::vector<G4UImessenger*> Messengers;
0051   typedef std::pair<T*, Messengers> ModelAndMessengers;
0052
0053   G4VModelFactory(const G4String& name);
0054
0055   virtual ~G4VModelFactory();
0056
0057   G4String Name();
0058
0059   virtual ModelAndMessengers Create(const G4String& placement, const G4String& modelName) = 0;
0060
0061   void Print(std::ostream& ostr) const;
0062
0063 private:
0064
0065   G4String fName;
0066
0067 };
0068
0069 template <typename T>
0070 G4VModelFactory<T>::G4VModelFactory(const G4String& name)
0071   :fName(name)
0072 {}
0073
0074 template <typename T>
0075 G4VModelFactory<T>::~G4VModelFactory() {}
0076
0077 template <typename T>
0078 G4String
0079 G4VModelFactory<T>::Name()
0080 {
0081   return fName;
0082 }
0083
0084 template <typename T>
0085 void
0086 G4VModelFactory<T>::Print(std::ostream& ostr) const
0087 {
0088   ostr<<"  "<<fName<<std::endl;
0089 }
0090
0091 #endif
0092