G4VReadOutGeometry Class Reference

#include <G4VReadOutGeometry.hh>

Inheritance diagram for G4VReadOutGeometry:

Collaboration diagram for G4VReadOutGeometry:

Public Member Functions
	G4VReadOutGeometry ()
	G4VReadOutGeometry (G4String)
virtual	~G4VReadOutGeometry ()
G4int	operator== (const G4VReadOutGeometry &right) const
G4int	operator!= (const G4VReadOutGeometry &right) const
void	BuildROGeometry ()
virtual G4bool	CheckROVolume (G4Step *, G4TouchableHistory *&)
const G4SensitiveVolumeList *	GetIncludeList () const
void	SetIncludeList (G4SensitiveVolumeList *value)
const G4SensitiveVolumeList *	GetExcludeList () const
void	SetExcludeList (G4SensitiveVolumeList *value)
G4String	GetName () const
void	SetName (G4String value)
G4VPhysicalVolume *	GetROWorld () const

Protected Member Functions
virtual G4VPhysicalVolume *	Build ()=0
	G4VReadOutGeometry (const G4VReadOutGeometry &right)
G4VReadOutGeometry &	operator= (const G4VReadOutGeometry &right)
virtual G4bool	FindROTouchable (G4Step *)

Protected Attributes
G4VPhysicalVolume *	ROworld
G4SensitiveVolumeList *	fincludeList
G4SensitiveVolumeList *	fexcludeList
G4String	name
G4Navigator *	ROnavigator
G4TouchableHistory *	touchableHistory

Detailed Description

Definition at line 40 of file G4VReadOutGeometry.hh.

Constructor & Destructor Documentation

G4VReadOutGeometry() [1/3]

G4VReadOutGeometry::G4VReadOutGeometry

(

)

Definition at line 34 of file G4VReadOutGeometry.cc.

  :ROworld(nullptr),fincludeList(nullptr),
   fexcludeList(nullptr),touchableHistory(nullptr)
{
  name = "unknown";
  ROnavigator = new G4Navigator();
  G4ExceptionDescription ed;
  ed<<"The concept and the functionality of Readout Geometry has been merged\n"
    <<"into Parallel World. This G4VReadOutGeometry is kept for the sake of\n"
    <<"not breaking the commonly-used interface in the sensitive detector class.\n"
    <<"But this functionality of G4VReadOutGeometry class is no longer tested\n"
    <<"and thus may not be working well. We strongly recommend our customers to\n"
    <<"migrate to Parallel World scheme.";
  G4Exception("G4VReadOutGeometry","DIGIHIT1001",JustWarning,ed);
}

Here is the call graph for this function:

G4VReadOutGeometry() [2/3]

G4VReadOutGeometry::G4VReadOutGeometry

(

G4String

n

)

Definition at line 62 of file G4VReadOutGeometry.cc.

  :ROworld(nullptr),fincludeList(nullptr),
   fexcludeList(nullptr),name(n),touchableHistory(nullptr)
{
  ROnavigator = new G4Navigator();
  G4ExceptionDescription ed;
  ed<<"The concept and the functionality of Readout Geometry has been merged\n"
    <<"into Parallel World. This G4VReadOutGeometry is kept for the sake of\n"
    <<"not breaking the commonly-used interface in the sensitive detector class.\n"
    <<"But this functionality of G4VReadOutGeometry class is no longer tested\n"
    <<"and thus may not be working well. We strongly recommend our customers to\n"
    <<"migrate to Parallel World scheme.";
  G4Exception("G4VReadOutGeometry","DIGIHIT1001",JustWarning,ed);
}

Here is the call graph for this function:

~G4VReadOutGeometry()

G4VReadOutGeometry::~G4VReadOutGeometry ( )

virtual

Definition at line 77 of file G4VReadOutGeometry.cc.

{ 
  //if(ROworld) delete ROworld; //should we do ? will it delete the goem tree also ?
  if(fincludeList)     delete fincludeList;
  if(fexcludeList)     delete fexcludeList;
  if(touchableHistory) delete touchableHistory;
  if(ROnavigator)      delete ROnavigator;
}

G4VReadOutGeometry() [3/3]

G4VReadOutGeometry::G4VReadOutGeometry ( const G4VReadOutGeometry &  right )

protected

Definition at line 50 of file G4VReadOutGeometry.cc.

{
  fincludeList = nullptr;
  fexcludeList = nullptr;
  name = right.name;
  ROworld = right.ROworld;
  touchableHistory = nullptr;
  ROnavigator = new G4Navigator();
  // COPY CONSTRUCTOR NOT STRAIGHT FORWARD: need to copy the touchabelHistory
  // VALUE, same for navigator and same for the World+Geom hierachy
}

Member Function Documentation

Build()

virtual G4VPhysicalVolume* G4VReadOutGeometry::Build ( )

protectedpure virtual

Implemented in IORTDetectorROGeometry, CML2ReadOutGeometry, ExN04CalorimeterROGeometry, RE01CalorimeterROGeometry, and ExN04CalorimeterROGeometry.

Here is the caller graph for this function:

BuildROGeometry()

void G4VReadOutGeometry::BuildROGeometry

(

)

Definition at line 104 of file G4VReadOutGeometry.cc.

{
  ROworld = Build();
  ROnavigator->SetWorldVolume(ROworld);
}

Here is the call graph for this function:

Here is the caller graph for this function:

CheckROVolume()

G4bool G4VReadOutGeometry::CheckROVolume ( G4Step *  currentStep, G4TouchableHistory *&  ROhist  )

virtual

Definition at line 110 of file G4VReadOutGeometry.cc.

{
  ROhist = nullptr;
  G4bool incFlg = true;
  G4VPhysicalVolume* PV = currentStep->GetPreStepPoint()->GetPhysicalVolume();
  if((fexcludeList)&&(fexcludeList->CheckPV(PV)))
    { incFlg = false; }
  else if ((fincludeList)&&(fincludeList->CheckPV(PV)))
    { incFlg = true; }
  else if((fexcludeList)&&(fexcludeList->CheckLV(PV->GetLogicalVolume())))
    { incFlg = false; }
  else if((fincludeList)&&(fincludeList->CheckLV(PV->GetLogicalVolume())))
    { incFlg = true; }
  if(!incFlg) return false;
  
  if(ROworld)
    { incFlg = FindROTouchable(currentStep); }
  if(incFlg)
    { ROhist = touchableHistory; }
  return incFlg;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FindROTouchable()

G4bool G4VReadOutGeometry::FindROTouchable ( G4Step *  currentStep )

protectedvirtual

Definition at line 132 of file G4VReadOutGeometry.cc.

{
  // Update G4TouchableHistory object (touchableHistory)
  // using the parallel readout world (ROworld)
  // Return false in case the current Step is outside of the
  // sensitive volume of the readout world.

  // At first invokation, creates the touchable history. Note
  // that default value (false) of Locate method is used.
  //  ---------> But the default Value is TRUE <-------------------- J.A. 
  if(!touchableHistory)
    {
      touchableHistory = new G4TouchableHistory();
      ROnavigator->LocateGlobalPointAndUpdateTouchable(
                 currentStep->GetPreStepPoint()->GetPosition(),
                 currentStep->GetPreStepPoint()->GetMomentumDirection(),
                 touchableHistory);
    }
  else
    {
      ROnavigator->LocateGlobalPointAndUpdateTouchable(
                 currentStep->GetPreStepPoint()->GetPosition(),
                 currentStep->GetPreStepPoint()->GetMomentumDirection(),
                 touchableHistory,
                 true);
    }
  // Can the above be improved by the use of an isotropic safety
  // in order to avoid LocateGlobalPointAndUpdateTouchable
  // at each Step ?
  // Should require that an RO geometry is notified at the
  // starting of a track to avoid possible confusion looking
  // at the safety value only.
  
  // checks if volume is sensitive:
  G4VPhysicalVolume* currentVolume = touchableHistory->GetVolume();
  // checks first if a physical volume exists here:
  if ( currentVolume )
    {
      return currentVolume->GetLogicalVolume()->
    GetSensitiveDetector() != 0;
    }
  // no sensitive volume found: returns false
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetExcludeList()

const G4SensitiveVolumeList* G4VReadOutGeometry::GetExcludeList ( ) const

inline

Definition at line 79 of file G4VReadOutGeometry.hh.

      { return fexcludeList; }

GetIncludeList()

const G4SensitiveVolumeList* G4VReadOutGeometry::GetIncludeList ( ) const

inline

Definition at line 75 of file G4VReadOutGeometry.hh.

      { return fincludeList; }

GetName()

G4String G4VReadOutGeometry::GetName ( void  ) const

inline

Definition at line 83 of file G4VReadOutGeometry.hh.

      { return name; }

Here is the caller graph for this function:

GetROWorld()

G4VPhysicalVolume* G4VReadOutGeometry::GetROWorld ( ) const

inline

Definition at line 88 of file G4VReadOutGeometry.hh.

      { return ROworld;}

Here is the caller graph for this function:

operator!=()

G4int G4VReadOutGeometry::operator!=

(

const G4VReadOutGeometry &

right

)

const

Definition at line 101 of file G4VReadOutGeometry.cc.

{ return (this != (G4VReadOutGeometry *) &right); }

operator=()

G4VReadOutGeometry & G4VReadOutGeometry::operator= ( const G4VReadOutGeometry &  right )

protected

Definition at line 86 of file G4VReadOutGeometry.cc.

{
  if ( this == &right ) return *this;
  delete fincludeList; fincludeList     = nullptr;
  delete fexcludeList; fexcludeList     = nullptr;
  name             = right.name;
  ROworld          = right.ROworld;
  delete touchableHistory; touchableHistory = nullptr;
  delete ROnavigator; ROnavigator = new G4Navigator();
  return *this;
}

operator==()

G4int G4VReadOutGeometry::operator==

(

const G4VReadOutGeometry &

right

)

const

Definition at line 98 of file G4VReadOutGeometry.cc.

{ return (this == (G4VReadOutGeometry *) &right); }

SetExcludeList()

void G4VReadOutGeometry::SetExcludeList ( G4SensitiveVolumeList *  value )

inline

Definition at line 81 of file G4VReadOutGeometry.hh.

      { fexcludeList = value; }

SetIncludeList()

void G4VReadOutGeometry::SetIncludeList ( G4SensitiveVolumeList *  value )

inline

Definition at line 77 of file G4VReadOutGeometry.hh.

      { fincludeList = value; }

SetName()

void G4VReadOutGeometry::SetName ( G4String  value )

inline

Definition at line 85 of file G4VReadOutGeometry.hh.

      { name = value; }

Member Data Documentation

fexcludeList

G4SensitiveVolumeList* G4VReadOutGeometry::fexcludeList

protected

Definition at line 68 of file G4VReadOutGeometry.hh.

fincludeList

G4SensitiveVolumeList* G4VReadOutGeometry::fincludeList

protected

Definition at line 67 of file G4VReadOutGeometry.hh.

name

G4String G4VReadOutGeometry::name

protected

Definition at line 69 of file G4VReadOutGeometry.hh.

ROnavigator

G4Navigator* G4VReadOutGeometry::ROnavigator

protected

Definition at line 71 of file G4VReadOutGeometry.hh.

ROworld

G4VPhysicalVolume* G4VReadOutGeometry::ROworld

protected

Definition at line 66 of file G4VReadOutGeometry.hh.

touchableHistory

G4TouchableHistory* G4VReadOutGeometry::touchableHistory

protected

Definition at line 72 of file G4VReadOutGeometry.hh.

---

The documentation for this class was generated from the following files:

• G4VReadOutGeometry.hh
• G4VReadOutGeometry.cc