eASTVDetectorComponent.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file eASTVDetectorComponent.hh

// ********************************************************************
//
// eASTVDetectorComponent.hh
//   Header file of the abstract base class of eAST detector component
//
// History
//   May 8th, 2021 : first implementation
//
// ********************************************************************

#ifndef eASTVDetectorComponent_H
#define eASTVDetectorComponent_H 1

class G4VPhysicalVolume;
class G4LogicalVolume;
class G4Region;
class eASTDetectorComponentMessenger;
class eASTUserActionDispatcher;

class G4UserRunAction;
class G4UserEventAction;
class G4UserStackingAction;
class G4UserTrackingAction;
class G4UserSteppingAction;

#include "globals.hh"
#include "G4ThreeVector.hh"
#include "G4RotationMatrix.hh"

class eASTVDetectorComponent
{
  public:
    eASTVDetectorComponent(G4String compName, G4int vl = 0);
    virtual ~eASTVDetectorComponent();

  public:
    // invoked only in the master thread
    virtual void SetUp() = 0;
    virtual void Construct(G4VPhysicalVolume*) = 0;
    virtual void ConstructActionForMaster()
    {;}

    // invoked in the worker threads (not in master)
    virtual void ConstructSD()
    {;}
    virtual void ConstructActions()
    {;}

  protected:
    // Utility method to locate the component
    void Locate(G4LogicalVolume* compLogVol, G4VPhysicalVolume* worldPhys);
    G4String LocateDataFile( const G4String fn ) const;

  protected:
    // Utility methods to register component-specific
    // user action classes. These methods should be used 
    // in ConstructActions() and ConstructActionForMaster()
    // methods.
    void RegisterUserAction(G4UserRunAction*);
    void RegisterUserAction(G4UserEventAction*);
    void RegisterUserAction(G4UserStackingAction*);
    void RegisterUserAction(G4UserTrackingAction*);
    void RegisterUserAction(G4UserSteppingAction*);

  protected:
    // Utility method to define a material to a logical
    // volume. The input file is an ASCII file, and 
    // each line of the file should have the name of
    // a logical volume and its material name.
    // Material name must be a name that appears in
    // G4NistManager.
    void ReadMaterialFile(G4String);

  protected:
    G4String componentName;
    G4String commandDir;
    G4int verboseLevel;
    G4VPhysicalVolume* pEnvelopePhys = nullptr;
    G4Region* pRegion = nullptr;

  public:
    void SetUpBase(G4int vl = 0);

  public:
    virtual G4VPhysicalVolume* GetEnvelope()
    { return pEnvelopePhys; }
    virtual G4Region* GetRegion()
    { return pRegion; }

  private:
    eASTDetectorComponentMessenger* baseMessenger;
    eASTUserActionDispatcher* userActionDispatcher;

  private:
    G4ThreeVector fPosition;
    G4RotationMatrix fRotation;

  public:
    void SetLocation(G4ThreeVector pos)
    { fPosition = pos; }
    void SetRotation(G4String ax,G4double ang)
    {
      if(ax=="x") fRotation.rotateX(ang);
      if(ax=="y") fRotation.rotateY(ang);
      if(ax=="z") fRotation.rotateZ(ang);
    }
    G4ThreeVector GetLocation()
    { return fPosition; }
    G4RotationMatrix GetRotation()
    { return fRotation; }

  private:
    G4bool CheckRegion();
};

#endif