/scratch0/jsnuveri/BDSIM/BDSIMgit/bdsim/include/BDSBeamPipeFactoryBase.hh

#ifndef BDSBEAMPIPEFACTORYBASE_H
#define BDSBEAMPIPEFACTORYBASE_H

#include "BDSBeamPipe.hh"

#include "globals.hh"         // geant4 globals / types
#include "G4Material.hh"      // materials

class G4UserLimits;

class BDSBeamPipeFactoryBase
{
public:
  // NOTE each derived class is expected to be a singleton but this can't be specified here
  // as it'd refer to the abstract base class - must be implemented in each derived class
  // utilised in BDSBeamPipeFactory.cc

  // 'In' in argument variables is used to distinguish between that and possible
  // internal member variables with the same name - avoiding 'itsVariable'
  
  virtual BDSBeamPipe* CreateBeamPipe(G4String    nameIn,                    // name
                                      G4double    lengthIn,                  // length [mm]
                                      G4double    aper1 = 0,                 // aperture parameter 1
                                      G4double    aper2 = 0,                 // aperture parameter 2
                                      G4double    aper3 = 0,                 // aperture parameter 3
                                      G4double    aper4 = 0,                 // aperture parameter 4
                                      G4Material* vacuumMaterialIn = NULL,   // vacuum material
                                      G4double    beamPipeThicknessIn = 0,   // beampipe thickness [mm]
                                      G4Material* beamPipeMaterialIn = NULL  // beampipe material
                                      ) = 0;

  virtual BDSBeamPipe* CreateBeamPipeAngledIn(   G4String    nameIn,
                                                 G4double    lengthIn,
                                                 G4double    angleInIn, // the normal angle of the input face
                                                 G4double    aper1 = 0,
                                                 G4double    aper2 = 0,
                                                 G4double    aper3 = 0,
                                                 G4double    aper4 = 0,
                                                 G4Material* vacuumMaterialIn = NULL,
                                                 G4double    beamPipeThicknessIn = 0,
                                                 G4Material* beamPipeMaterialIn = NULL
                                                 );

  virtual BDSBeamPipe* CreateBeamPipeAngledOut(  G4String    nameIn,
                                                 G4double    lengthIn,
                                                 G4double    angleOutIn, // the normal angle of the output face
                                                 G4double    aper1 = 0,
                                                 G4double    aper2 = 0,
                                                 G4double    aper3 = 0,
                                                 G4double    aper4 = 0,
                                                 G4Material* vacuumMaterialIn = NULL,
                                                 G4double    beamPipeThicknessIn = 0,
                                                 G4Material* beamPipeMaterialIn = NULL
                                                 );
  
  virtual BDSBeamPipe* CreateBeamPipeAngledInOut(G4String    nameIn,
                                                 G4double    lengthIn,
                                                 G4double    angleInIn,  // the normal angle of the input face
                                                 G4double    angleOutIn, // the normal angle of the output face
                                                 G4double    aper1 = 0,
                                                 G4double    aper2 = 0,
                                                 G4double    aper3 = 0,
                                                 G4double    aper4 = 0,
                                                 G4Material* vacuumMaterialIn = NULL,
                                                 G4double    beamPipeThicknessIn = 0,
                                                 G4Material* beamPipeMaterialIn = NULL
                                                 ) = 0;

protected:
  BDSBeamPipeFactoryBase();

  virtual void CleanUp();
  
  void CommonConstruction(G4String    nameIn,
                          G4Material* vacuumMaterialIn,
                          G4Material* beamPipeMaterialIn,
                          G4double    lengthIn);

  BDSBeamPipe* BuildBeamPipeAndRegisterVolumes(std::pair<double,double> extX,
                                               std::pair<double,double> extY,
                                               std::pair<double,double> extZ,
                                               G4double containerRadius);

  std::pair<G4ThreeVector,G4ThreeVector> CalculateFaces(G4double angleInIn,
                                                        G4double angleOutIn);

  void TestInputParameters(G4Material*& vacuumMaterialIn,
                           G4double&    beamPipeThicknessIn,
                           G4Material*& beamPipeMaterialIn);
  
  // methods called by CommonConstruction, can be implmented by derived classes
  
  virtual void BuildLogicalVolumes(G4String    nameIn,
                                   G4Material* vacuumMaterialIn,
                                   G4Material* beamPipeMaterialIn);
  virtual void          SetVisAttributes();

  virtual G4UserLimits* SetUserLimits(G4double lengthIn);

  virtual void          PlaceComponents(G4String nameIn);

protected:
  G4double         lengthSafety;
  G4bool           checkOverlaps;
  G4double         maxStepFactor;
  G4double         nSegmentsPerCircle; // for visualisation improvement
  G4VSolid*        vacuumSolid;
  G4VSolid*        beamPipeSolid;
  G4VSolid*        containerSolid;
  G4VSolid*        containerSubtractionSolid; 
  G4LogicalVolume* vacuumLV;
  G4LogicalVolume* beamPipeLV;
  G4LogicalVolume* containerLV;

};

#endif

---