G4Event Class Reference

#include <G4Event.hh>

Public Member Functions
	G4Event ()=default
	G4Event (G4int evID)
	~G4Event ()
	G4Event (const G4Event &)=delete
G4Event &	operator= (const G4Event &)=delete
void *	operator new (std::size_t)
void	operator delete (void *anEvent)
G4bool	operator== (const G4Event &right) const
G4bool	operator!= (const G4Event &right) const
void	Print () const
void	Draw () const
void	SetEventID (G4int i)
void	SetHCofThisEvent (G4HCofThisEvent *value)
void	SetDCofThisEvent (G4DCofThisEvent *value)
void	SetTrajectoryContainer (G4TrajectoryContainer *value)
void	SetEventAborted ()
void	SetRandomNumberStatus (G4String &st)
void	SetRandomNumberStatusForProcessing (G4String &st)
void	KeepTheEvent (G4bool vl=true) const
G4bool	KeepTheEventFlag () const
G4bool	ToBeKept () const
void	KeepForPostProcessing () const
void	PostProcessingFinished () const
G4int	GetNumberOfGrips () const
G4int	GetEventID () const
void	AddPrimaryVertex (G4PrimaryVertex *aPrimaryVertex)
G4int	GetNumberOfPrimaryVertex () const
G4PrimaryVertex *	GetPrimaryVertex (G4int i=0) const
G4HCofThisEvent *	GetHCofThisEvent () const
G4DCofThisEvent *	GetDCofThisEvent () const
G4TrajectoryContainer *	GetTrajectoryContainer () const
G4bool	IsAborted () const
void	SetUserInformation (G4VUserEventInformation *anInfo)
G4VUserEventInformation *	GetUserInformation () const
const G4String &	GetRandomNumberStatus () const
const G4String &	GetRandomNumberStatusForProcessing () const
G4SubEvent *	PopSubEvent (G4int)
G4int	TerminateSubEvent (G4SubEvent *)
G4int	StoreSubEvent (G4int, G4SubEvent *)
G4int	SpawnSubEvent (G4SubEvent *)
G4int	GetNumberOfRemainingSubEvents () const
G4int	GetNumberOfCompletedSubEvent () const
void	MergeSubEventResults (const G4Event *se)
void	FlagAsSubEvent (G4Event *me, G4int ty)
G4Event *	GetMotherEvent () const
G4int	GetSubEventType () const
void	ScoresRecorded () const
G4bool	ScoresAlreadyRecorded () const
void	EventCompleted () const
G4bool	IsEventCompleted () const

Detailed Description

Definition at line 58 of file G4Event.hh.

Constructor & Destructor Documentation

G4Event() [1/3]

G4Event::G4Event ( )

default

Referenced by FlagAsSubEvent(), G4Event(), GetMotherEvent(), MergeSubEventResults(), operator delete(), operator!=(), operator=(), and operator==().

G4Event() [2/3]

G4Event::G4Event ( G4int evID )

explicit

Definition at line 50 of file G4Event.cc.

  : eventID(evID)
{
}

~G4Event()

G4Event::~G4Event

(

)

Definition at line 55 of file G4Event.cc.

{
  G4PrimaryVertex* nextVertex = thePrimaryVertex;
  while(nextVertex != nullptr)
  {
    G4PrimaryVertex* thisVertex = nextVertex;
    nextVertex = thisVertex->GetNext();
    thisVertex->ClearNext();
    delete thisVertex;
  }
  thePrimaryVertex = nullptr;
  delete HC;
  delete DC;
  if(trajectoryContainer != nullptr)
  {
    trajectoryContainer->clearAndDestroy();
    delete trajectoryContainer;
  }
  delete userInfo;
  delete randomNumberStatus;
  delete randomNumberStatusForProcessing;
 
  // TODO (PHASE-II): count remaining subevents for scoring
  for(auto& sem : fSubEvtStackMap)
  {
    if((sem.second!=nullptr)&&!(sem.second->empty()))
    {
      for(auto& se : *(sem.second))
      { delete se; }
      sem.second->clear();
    }
  }
  /* TODO (PHASE-II): Handle incorrect scoring
  if(!scoresRecorded) {
    G4ExceptionDescription ed;
    ed << "Deleting G4Event (id:" << eventID << ") that still has unrecorded scores -- "
       << remainingSE << " sub-events un-processed.";
    G4Exception("G4Event::~G4Event()","SubEvt0001",FatalException,ed);
  } else if(remainingSE>0) {
    G4ExceptionDescription ed;
    ed << "Deleting G4Event (id:" << eventID << ") that still has "
       << remainingSE << " sub-events un-processed.";
    G4Exception("G4Event::~G4Event()","SubEvt0002",FatalException,ed);
  }
  */
  if(!(fSubEvtVector.empty()))
  {
    for(auto& se : fSubEvtVector)
    {
      G4cout << "SubEvent " << se << " belongs to " << se->GetEvent()
             << " (eventID=" << se->GetEvent()->GetEventID() << ") that has "
             << se->GetNTrack() << " stacked tracks"<<G4endl;
    }
    G4ExceptionDescription ed;
    ed << "Deleting G4Event (id:" << eventID << ") that has "
       << fSubEvtVector.size() << " sub-events still processing.";
    G4Exception("G4Event::~G4Event()","SubEvt0003",FatalException,ed);
    // TODO (PHASE-II): Handle deletion of subevents correctly
    //for(auto& se : fSubEvtVector)
    //{ delete se; }
    //fSubEvtVector.clear();
  }
 
  if(!(fSubEventGarbageBin.empty()))
  {
    for(auto& se : fSubEventGarbageBin)
    { delete se; }
    fSubEventGarbageBin.clear();
  }
}

G4Event() [3/3]

G4Event::G4Event ( const G4Event & )

delete

Member Function Documentation

AddPrimaryVertex()

void G4Event::AddPrimaryVertex ( G4PrimaryVertex * aPrimaryVertex )

inline

Definition at line 129 of file G4Event.hh.

      {
        //  This method sets a new primary vertex. This method must be invoked 
        // exclusively by G4VPrimaryGenerator concrete class.
 
        if( thePrimaryVertex == nullptr )
        { thePrimaryVertex = aPrimaryVertex; }
        else
        { thePrimaryVertex->SetNext( aPrimaryVertex ); }
        ++numberOfPrimaryVertex;
      }

Referenced by G4AdjointPrimaryGeneratorAction::GeneratePrimaries(), G4RTPrimaryGeneratorAction::GeneratePrimaries(), G4HEPEvtInterface::GeneratePrimaryVertex(), G4ParticleGun::GeneratePrimaryVertex(), G4SingleParticleSource::GeneratePrimaryVertex(), and G4RayShooter::Shoot().

Draw()

void G4Event::Draw

(

)

const

Definition at line 141 of file G4Event.cc.

{
  G4VVisManager* pVVisManager = G4VVisManager::GetConcreteInstance();
  if(pVVisManager == nullptr) return;
 
  if(trajectoryContainer != nullptr)
  {
    std::size_t n_traj = trajectoryContainer->entries();
    for(std::size_t i=0; i<n_traj; ++i)
    { (*trajectoryContainer)[i]->DrawTrajectory(); }
  }
 
  if(HC != nullptr)
  {
    std::size_t n_HC = HC->GetCapacity();
    for(std::size_t j=0; j<n_HC; ++j)
    {
      G4VHitsCollection* VHC = HC->GetHC((G4int)j);
      if(VHC != nullptr) VHC->DrawAllHits();
    }
  }
 
  if(DC != nullptr)
  {
    std::size_t n_DC = DC->GetCapacity();
    for(std::size_t j=0; j<n_DC; ++j)
    {
      G4VDigiCollection* VDC = DC->GetDC((G4int)j);
      if(VDC != nullptr) VDC->DrawAllDigi();
    }
  }
}

EventCompleted()

void G4Event::EventCompleted ( ) const

inline

Definition at line 303 of file G4Event.hh.

{ eventCompleted = true; }

Referenced by G4SubEvtRunManager::CleanUpUnnecessaryEvents(), and G4SubEvtRunManager::StackPreviousEvent().

FlagAsSubEvent()

void G4Event::FlagAsSubEvent ( G4Event * me, G4int ty )

inline

Definition at line 287 of file G4Event.hh.

    {
      motherEvent = me;
      subEventType = ty;
    }

Referenced by G4WorkerSubEvtRunManager::DoWork().

GetDCofThisEvent()

G4DCofThisEvent * G4Event::GetDCofThisEvent ( ) const

inline

Definition at line 166 of file G4Event.hh.

      { return DC; }

Referenced by G4DigiManager::GetDigiCollection(), G4DigiManager::SetDigiCollection(), and G4PersistencyManager::Store().

GetEventID()

G4int G4Event::GetEventID ( ) const

inline

Definition at line 126 of file G4Event.hh.

      { return eventID; }

Referenced by G4VisManager::Draw(), G4Pevent::G4Pevent(), G4AdjointPrimaryGeneratorAction::GeneratePrimaries(), G4RTPrimaryGeneratorAction::GeneratePrimaries(), G4EventManager::ProcessOneEvent(), G4RTRun::RecordEvent(), G4RunManager::ReportEventDeletion(), G4PersistencyManager::Retrieve(), G4OpenGLSceneHandler::ScaledFlush(), G4PersistencyManager::Store(), TerminateSubEvent(), and G4RunManager::UpdateScoring().

GetHCofThisEvent()

G4HCofThisEvent * G4Event::GetHCofThisEvent ( ) const

inline

Definition at line 164 of file G4Event.hh.

      { return HC; }

Referenced by G4DigiManager::GetHitsCollection(), G4PersistencyManager::Store(), G4RunManager::UpdateScoring(), and G4SubEvtRunManager::UpdateScoringForSubEvent().

GetMotherEvent()

G4Event * G4Event::GetMotherEvent ( ) const

inline

Definition at line 292 of file G4Event.hh.

    { return motherEvent; }

GetNumberOfCompletedSubEvent()

G4int G4Event::GetNumberOfCompletedSubEvent ( ) const

inline

Definition at line 260 of file G4Event.hh.

    { return (G4int)fSubEventGarbageBin.size(); }

Referenced by G4RunManager::ReportEventDeletion().

GetNumberOfGrips()

G4int G4Event::GetNumberOfGrips ( ) const

inline

Definition at line 123 of file G4Event.hh.

      { return grips; }

Referenced by G4RunManager::CleanUpUnnecessaryEvents(), G4SubEvtRunManager::CleanUpUnnecessaryEvents(), G4RunManager::ReportEventDeletion(), G4RunManager::StackPreviousEvent(), and G4SubEvtRunManager::StackPreviousEvent().

GetNumberOfPrimaryVertex()

G4int G4Event::GetNumberOfPrimaryVertex ( ) const

inline

Definition at line 141 of file G4Event.hh.

      { return numberOfPrimaryVertex; }

GetNumberOfRemainingSubEvents()

G4int G4Event::GetNumberOfRemainingSubEvents

(

)

const

Definition at line 277 of file G4Event.cc.

{
  G4AutoLock lock(&SubEventMutex);
  auto  tot = (G4int)fSubEvtVector.size(); 
  for(auto& sem : fSubEvtStackMap)
  { tot += (G4int)sem.second->size(); }
  return tot;
}

Referenced by G4SubEvtRunManager::CleanUpUnnecessaryEvents(), G4RunManager::ReportEventDeletion(), G4SubEvtRunManager::StackPreviousEvent(), and ToBeKept().

GetPrimaryVertex()

G4PrimaryVertex * G4Event::GetPrimaryVertex ( G4int i = 0 ) const

inline

Definition at line 145 of file G4Event.hh.

      { 
        if( i == 0 )
        { return thePrimaryVertex; }
        if( i > 0 && i < numberOfPrimaryVertex )
        {
          G4PrimaryVertex* primaryVertex = thePrimaryVertex;
          for( G4int j=0; j<i; ++j )
          {
            if( primaryVertex == nullptr ) return nullptr; 
            primaryVertex = primaryVertex->GetNext();
          }
          return primaryVertex;
        }
        
        return nullptr;
      }

Referenced by G4AdjointPrimaryGeneratorAction::GeneratePrimaries(), and G4PrimaryTransformer::GimmePrimaries().

GetRandomNumberStatus()

const G4String & G4Event::GetRandomNumberStatus ( ) const

inline

Definition at line 185 of file G4Event.hh.

      {
        if(!validRandomNumberStatus)
        { G4Exception(
              "G4Event::GetRandomNumberStatus","Event0701",JustWarning,
              "Random number status is not available for this event."); }
        return *randomNumberStatus;
      }

GetRandomNumberStatusForProcessing()

const G4String & G4Event::GetRandomNumberStatusForProcessing ( ) const

inline

Definition at line 193 of file G4Event.hh.

      {
        if(!validRandomNumberStatusForProcessing)
        { G4Exception(
              "G4Event::GetRandomNumberStatusForProcessing","Event0702",
              JustWarning,
              "Random number status is not available for this event."); }
        return *randomNumberStatusForProcessing;
      }

GetSubEventType()

G4int G4Event::GetSubEventType ( ) const

inline

Definition at line 294 of file G4Event.hh.

    { return subEventType; }

GetTrajectoryContainer()

G4TrajectoryContainer * G4Event::GetTrajectoryContainer ( ) const

inline

Definition at line 168 of file G4Event.hh.

      { return trajectoryContainer; }

Referenced by G4TheRayTracer::GenerateColour(), G4SubEvtRunManager::MergeTrajectories(), and G4RTRun::RecordEvent().

GetUserInformation()

G4VUserEventInformation * G4Event::GetUserInformation ( ) const

inline

Definition at line 181 of file G4Event.hh.

      { return userInfo; }

IsAborted()

G4bool G4Event::IsAborted ( ) const

inline

Definition at line 175 of file G4Event.hh.

{ return eventAborted; }

IsEventCompleted()

G4bool G4Event::IsEventCompleted ( ) const

inline

Definition at line 304 of file G4Event.hh.

{ return eventCompleted; }

Referenced by G4SubEvtRunManager::CleanUpUnnecessaryEvents(), and G4SubEvtRunManager::StackPreviousEvent().

KeepForPostProcessing()

void G4Event::KeepForPostProcessing ( ) const

inline

Definition at line 112 of file G4Event.hh.

      { ++grips; }

KeepTheEvent()

void G4Event::KeepTheEvent ( G4bool vl = true ) const

inline

Definition at line 101 of file G4Event.hh.

      { keepTheEvent = vl; }

KeepTheEventFlag()

G4bool G4Event::KeepTheEventFlag ( ) const

inline

Definition at line 103 of file G4Event.hh.

      { return keepTheEvent; }

Referenced by G4RunManager::ReportEventDeletion().

MergeSubEventResults()

void G4Event::MergeSubEventResults

(

const G4Event *

se

)

Definition at line 225 of file G4Event.cc.

{
  // TODO (PHASE-II): Handle merging of subevent trajectories
  // Note:
  //     - scores are merged directly to the scoring manager
  //     - hits collections should be merged by the user event action
  /*
#ifdef G4_STORE_TRAJECTORY
  if(se->trajectoryContainer!=nullptr && se->trajectoryContainer->size()>0)
  {
    if(trajectoryContainer==nullptr) trajectoryContainer = new G4TrajectoryContainer;
    for(auto& trj : *(se->trajectoryContainer->GetVector()))
    { trajectoryContainer->push_back(trj); }
  }
#endif
*/
}

Referenced by G4EventManager::TerminateSubEvent().

operator delete()

void G4Event::operator delete ( void * anEvent )

inline

Definition at line 318 of file G4Event.hh.

{
  anEventAllocator()->FreeSingle((G4Event*)anEvent);
}

operator new()

void * G4Event::operator new ( std::size_t )

inline

Definition at line 309 of file G4Event.hh.

{ 
  if (anEventAllocator() == nullptr) 
  {
    anEventAllocator() = new G4Allocator<G4Event>;
  }
  return (void*)anEventAllocator()->MallocSingle();
}

operator!=()

G4bool G4Event::operator!=

(

const G4Event &

right

)

const

Definition at line 131 of file G4Event.cc.

{
  return ( eventID != right.eventID );
}

operator=()

G4Event & G4Event::operator= ( const G4Event & )

delete

operator==()

G4bool G4Event::operator==

(

const G4Event &

right

)

const

Definition at line 126 of file G4Event.cc.

{
  return ( eventID == right.eventID );
}

PopSubEvent()

G4SubEvent * G4Event::PopSubEvent

(

G4int

ty

)

Definition at line 190 of file G4Event.cc.

{
  G4AutoLock lock(&SubEventMutex);
  G4SubEvent* se = nullptr;
  auto ses = fSubEvtStackMap.find(ty);
  if(ses!=fSubEvtStackMap.end())
  {
    auto sev = ses->second;
    if(!(sev->empty()))
    {
      se = sev->extract(sev->begin()).value();
      SpawnSubEvent(se);
    }
  }
  return se;
}

PostProcessingFinished()

void G4Event::PostProcessingFinished ( ) const

inline

Definition at line 114 of file G4Event.hh.

      {
        --grips;
        if (grips<0)
        {
          G4Exception("G4Event::Release()", "EVENT91001", JustWarning,
                      "Number of grips is negative. This cannot be correct.");
        }
      }

Print()

void G4Event::Print

(

)

const

Definition at line 136 of file G4Event.cc.

{
  G4cout << "G4Event " << eventID << G4endl;
}

ScoresAlreadyRecorded()

G4bool G4Event::ScoresAlreadyRecorded ( ) const

inline

Definition at line 302 of file G4Event.hh.

{ return scoresRecorded; }

Referenced by G4RunManager::UpdateScoring().

ScoresRecorded()

void G4Event::ScoresRecorded ( ) const

inline

Definition at line 301 of file G4Event.hh.

{ scoresRecorded = true; }

Referenced by G4SubEvtRunManager::SubEventFinished(), and G4RunManager::UpdateScoring().

SetDCofThisEvent()

void G4Event::SetDCofThisEvent ( G4DCofThisEvent * value )

inline

Definition at line 85 of file G4Event.hh.

      { DC = value; }

Referenced by G4DigiManager::SetDigiCollection().

SetEventAborted()

void G4Event::SetEventAborted ( )

inline

Definition at line 89 of file G4Event.hh.

      { eventAborted = true; }

SetEventID()

void G4Event::SetEventID ( G4int i )

inline

Definition at line 81 of file G4Event.hh.

      { eventID =  i; }

Referenced by G4MTRunManager::SetUpAnEvent(), G4TaskRunManager::SetUpAnEvent(), G4MTRunManager::SetUpNEvents(), and G4TaskRunManager::SetUpNEvents().

SetHCofThisEvent()

void G4Event::SetHCofThisEvent ( G4HCofThisEvent * value )

inline

Definition at line 83 of file G4Event.hh.

      { HC = value; }

SetRandomNumberStatus()

void G4Event::SetRandomNumberStatus ( G4String & st )

inline

Definition at line 91 of file G4Event.hh.

      {
        randomNumberStatus = new G4String(st);
        validRandomNumberStatus = true;
      }

Referenced by G4EventManager::ProcessOneEvent().

SetRandomNumberStatusForProcessing()

void G4Event::SetRandomNumberStatusForProcessing ( G4String & st )

inline

Definition at line 96 of file G4Event.hh.

      {
        randomNumberStatusForProcessing = new G4String(st);
        validRandomNumberStatusForProcessing = true;
      }

SetTrajectoryContainer()

void G4Event::SetTrajectoryContainer ( G4TrajectoryContainer * value )

inline

Definition at line 87 of file G4Event.hh.

      { trajectoryContainer = value; }

SetUserInformation()

void G4Event::SetUserInformation ( G4VUserEventInformation * anInfo )

inline

Definition at line 179 of file G4Event.hh.

      { userInfo = anInfo; }

SpawnSubEvent()

G4int G4Event::SpawnSubEvent

(

G4SubEvent *

se

)

Definition at line 207 of file G4Event.cc.

{
  // Can't use same mutex here as call by PopSubEvent but seems o.k. as only
  // caller is PopSubEvent
  //G4AutoLock lock(&SubEventMutex);
  auto ss = fSubEvtVector.find(se);
  if(ss!=fSubEvtVector.end())
  {
    G4ExceptionDescription ed;
    ed << "Sub-event " << se << " of type " << se->GetSubEventType()
       << " with " << se->GetNTrack() << " tracks has already spawned.";
    G4Exception("G4Event::SpawnSubEvent","SubEvent9001",
                FatalException,ed);
  }
  fSubEvtVector.insert(se);
  return (G4int)fSubEvtVector.size();
}

Referenced by PopSubEvent().

StoreSubEvent()

G4int G4Event::StoreSubEvent	(	G4int	ty,
		G4SubEvent *	se )

Definition at line 174 of file G4Event.cc.

{
  G4AutoLock lock(&SubEventMutex);
  std::set<G4SubEvent*>* sev = nullptr;
  auto ses = fSubEvtStackMap.find(ty);
  if(ses==fSubEvtStackMap.end())
  { 
    sev = new std::set<G4SubEvent*>;
    fSubEvtStackMap[ty] = sev;
  }
  else
  { sev = ses->second; }
  sev->insert(se);
  return (G4int)sev->size();
}

Referenced by G4EventManager::StoreSubEvent().

TerminateSubEvent()

G4int G4Event::TerminateSubEvent

(

G4SubEvent *

se

)

Definition at line 243 of file G4Event.cc.

{
  G4AutoLock lock(&SubEventMutex);
 
  auto ss = fSubEvtVector.find(se);
  if(ss==fSubEvtVector.end())
  {
    G4ExceptionDescription ed;
    ed << "Sub-event " << se << " of type " << se->GetSubEventType()
       << " with " << se->GetNTrack() << " tracks of event " << se->GetEvent()->GetEventID()
       << " in event " << se->GetEvent()
       << " has never been spawned.";
    G4Exception("G4Event::TerminateSubEvent","SubEvent9002",
                FatalException,ed);
  }
 
  fSubEvtVector.erase(ss);
 
  ss = fSubEvtVector.find(se);
  if(ss!=fSubEvtVector.end())
  {
    G4ExceptionDescription ed;
    ed << "Sub-event " << se << " of type " << se->GetSubEventType()
       << " with " << se->GetNTrack() << " appears more than once. PANIC!";
    G4Exception("G4Event::TerminateSubEvent","SubEvent9003",
                FatalException,ed);
  }
 
  //se->clearAndDestroy();
  //delete se;
  fSubEventGarbageBin.insert(se);
  return (G4int)fSubEvtVector.size();
}

ToBeKept()

G4bool G4Event::ToBeKept ( ) const

inline

Definition at line 105 of file G4Event.hh.

      {
        /* TODO (PHASE-II): consider grips for subevents
        { return keepTheEvent || grips>0 || GetNumberOfRemainingSubEvents()>0; }
        */
        return keepTheEvent || GetNumberOfRemainingSubEvents()>0;
      }

Referenced by G4RunManager::CleanUpPreviousEvents(), G4RunManager::CleanUpUnnecessaryEvents(), G4SubEvtRunManager::CleanUpUnnecessaryEvents(), G4RunManager::StackPreviousEvent(), and G4SubEvtRunManager::StackPreviousEvent().

---

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

• G4Event.hh
• G4Event.cc