G4VReadOutGeometry Class Reference

#include <G4VReadOutGeometry.hh>

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

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

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

Detailed Description

Definition at line 39 of file G4VReadOutGeometry.hh.

Constructor & Destructor Documentation

G4VReadOutGeometry() [1/3]

G4VReadOutGeometry::G4VReadOutGeometry

(

)

Definition at line 32 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);
}

References G4Exception(), JustWarning, name, and ROnavigator.

G4VReadOutGeometry() [2/3]

G4VReadOutGeometry::G4VReadOutGeometry

(

G4String

n

)

Definition at line 66 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);
}

References G4Exception(), JustWarning, and ROnavigator.

~G4VReadOutGeometry()

G4VReadOutGeometry::~G4VReadOutGeometry ( )

virtual

Definition at line 88 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;
}

References fexcludeList, fincludeList, ROnavigator, and touchableHistory.

G4VReadOutGeometry() [3/3]

G4VReadOutGeometry::G4VReadOutGeometry ( const G4VReadOutGeometry &  right )

protected

Definition at line 54 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
}

References fexcludeList, fincludeList, name, ROnavigator, ROworld, and touchableHistory.

Member Function Documentation

Build()

virtual G4VPhysicalVolume * G4VReadOutGeometry::Build ( )

protectedpure virtual

Referenced by BuildROGeometry().

BuildROGeometry()

void G4VReadOutGeometry::BuildROGeometry

(

)

Definition at line 130 of file G4VReadOutGeometry.cc.

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

References Build(), ROnavigator, ROworld, and G4Navigator::SetWorldVolume().

CheckROVolume()

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

virtual

Definition at line 136 of file G4VReadOutGeometry.cc.

{
  ROhist        = nullptr;
  G4bool incFlg = true;
  auto 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;
}

References G4SensitiveVolumeList::CheckLV(), G4SensitiveVolumeList::CheckPV(), fexcludeList, fincludeList, FindROTouchable(), G4StepPoint::GetPhysicalVolume(), G4Step::GetPreStepPoint(), ROworld, and touchableHistory.

Referenced by G4VFastSimSensitiveDetector::Hit(), G4VGFlashSensitiveDetector::Hit(), and G4VSensitiveDetector::Hit().

FindROTouchable()

G4bool G4VReadOutGeometry::FindROTouchable ( G4Step *  currentStep )

protectedvirtual

Definition at line 172 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:
  auto 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;
}

References G4VPhysicalVolume::GetLogicalVolume(), G4StepPoint::GetMomentumDirection(), G4StepPoint::GetPosition(), G4Step::GetPreStepPoint(), G4LogicalVolume::GetSensitiveDetector(), G4TouchableHistory::GetVolume(), G4Navigator::LocateGlobalPointAndUpdateTouchable(), ROnavigator, and touchableHistory.

Referenced by CheckROVolume().

GetExcludeList()

const G4SensitiveVolumeList * G4VReadOutGeometry::GetExcludeList ( ) const

inline

Definition at line 83 of file G4VReadOutGeometry.hh.

  {
    return fexcludeList;
  }

References fexcludeList.

GetIncludeList()

const G4SensitiveVolumeList * G4VReadOutGeometry::GetIncludeList ( ) const

inline

Definition at line 75 of file G4VReadOutGeometry.hh.

  {
    return fincludeList;
  }

References fincludeList.

GetName()

G4String G4VReadOutGeometry::GetName ( ) const

inline

Definition at line 91 of file G4VReadOutGeometry.hh.

{ return name; }

References name.

Referenced by G4LogicalVolumeModel::DescribeYourselfTo(), and G4ASCIITreeSceneHandler::RequestPrimitives().

GetROWorld()

G4VPhysicalVolume * G4VReadOutGeometry::GetROWorld ( ) const

inline

Definition at line 94 of file G4VReadOutGeometry.hh.

{ return ROworld; }

References ROworld.

Referenced by G4LogicalVolumeModel::DescribeYourselfTo().

operator!=()

G4bool G4VReadOutGeometry::operator!=

(

const G4VReadOutGeometry &

right

)

const

Definition at line 125 of file G4VReadOutGeometry.cc.

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

operator=()

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

protected

Definition at line 102 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;
}

References fexcludeList, fincludeList, name, ROnavigator, ROworld, and touchableHistory.

operator==()

G4bool G4VReadOutGeometry::operator==

(

const G4VReadOutGeometry &

right

)

const

Definition at line 120 of file G4VReadOutGeometry.cc.

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

SetExcludeList()

void G4VReadOutGeometry::SetExcludeList ( G4SensitiveVolumeList *  value )

inline

Definition at line 87 of file G4VReadOutGeometry.hh.

  {
    fexcludeList = value;
  }

References fexcludeList.

SetIncludeList()

void G4VReadOutGeometry::SetIncludeList ( G4SensitiveVolumeList *  value )

inline

Definition at line 79 of file G4VReadOutGeometry.hh.

  {
    fincludeList = value;
  }

References fincludeList.

SetName()

void G4VReadOutGeometry::SetName ( G4String  value )

inline

Definition at line 92 of file G4VReadOutGeometry.hh.

{ name = value; }

References name.

Field Documentation

fexcludeList

G4SensitiveVolumeList* G4VReadOutGeometry::fexcludeList

protected

Definition at line 68 of file G4VReadOutGeometry.hh.

Referenced by CheckROVolume(), G4VReadOutGeometry(), GetExcludeList(), operator=(), SetExcludeList(), and ~G4VReadOutGeometry().

fincludeList

G4SensitiveVolumeList* G4VReadOutGeometry::fincludeList

protected

Definition at line 67 of file G4VReadOutGeometry.hh.

Referenced by CheckROVolume(), G4VReadOutGeometry(), GetIncludeList(), operator=(), SetIncludeList(), and ~G4VReadOutGeometry().

name

G4String G4VReadOutGeometry::name

protected

Definition at line 69 of file G4VReadOutGeometry.hh.

Referenced by source.g4viscp.G4Scene::create_scene(), G4VReadOutGeometry(), GetName(), operator=(), mcscore.MCParticle::printout(), SetName(), and source.g4viscp.G4Scene::update_scene().

ROnavigator

G4Navigator* G4VReadOutGeometry::ROnavigator

protected

Definition at line 71 of file G4VReadOutGeometry.hh.

Referenced by BuildROGeometry(), FindROTouchable(), G4VReadOutGeometry(), operator=(), and ~G4VReadOutGeometry().

ROworld

G4VPhysicalVolume* G4VReadOutGeometry::ROworld

protected

Definition at line 66 of file G4VReadOutGeometry.hh.

Referenced by BuildROGeometry(), CheckROVolume(), G4VReadOutGeometry(), GetROWorld(), and operator=().

touchableHistory

G4TouchableHistory* G4VReadOutGeometry::touchableHistory

protected

Definition at line 72 of file G4VReadOutGeometry.hh.

Referenced by CheckROVolume(), FindROTouchable(), G4VReadOutGeometry(), operator=(), and ~G4VReadOutGeometry().

---

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

• source/digits_hits/detector/include/G4VReadOutGeometry.hh
• source/digits_hits/detector/src/G4VReadOutGeometry.cc