G4Event Class Reference

#include <G4Event.hh>

Public Types
using	ProfilerConfig = G4ProfilerConfig<G4ProfileType::Event>

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)
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
void	MergeSubEventResults (const G4Event *se)
void	FlagAsSubEvent (G4Event *me, G4int ty)
G4Event *	GetMotherEvent () const
G4int	GetSubEventType () const

Detailed Description

Definition at line 59 of file G4Event.hh.

Member Typedef Documentation

ProfilerConfig

using G4Event::ProfilerConfig = G4ProfilerConfig<G4ProfileType::Event>

Definition at line 62 of file G4Event.hh.

Constructor & Destructor Documentation

G4Event() [1/3]

G4Event::G4Event ( )

default

G4Event() [2/3]

G4Event::G4Event ( G4int evID )

explicit

Definition at line 44 of file G4Event.cc.

  : eventID(evID)
{
}

~G4Event()

G4Event::~G4Event

(

)

Definition at line 49 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;
 
  // Following G4Exception are temporally issuing JustWarning to delete 
  // unprocessed tracks in sub-events. Once sub-event mechanism is completely 
  // implemented, G4Exception should cause FatalException.
 
  G4int remainingSE = 0;
  for(auto& sem : fSubEvtStackMap)
  {
    if((sem.second!=nullptr)&&!(sem.second->empty()))
    {
      remainingSE += sem.second->size();
      for(auto& se : *(sem.second))
      {
        se->clearAndDestroy();
      }
      sem.second->clear();
    }
  }
  if(remainingSE>0)
  {
    G4ExceptionDescription ed;
    ed << "Deleting G4Event (id:" << eventID << ") that still has "
       << remainingSE << " sub-events un-processed.";
    G4Exception("G4Event::~G4Event()","SubEvt0001",JustWarning,ed);
  }
 
  if(!(fSubEvtVector.empty()))
  {
    G4ExceptionDescription ed;
    ed << "Deleting G4Event (id:" << eventID << ") that has "
       << fSubEvtVector.size() << " sub-events still processing.";
    G4Exception("G4Event::~G4Event()","SubEvt0001",JustWarning,ed);
    for(auto& se : fSubEvtVector)
    {
      se->clearAndDestroy();
      delete se;
    }
  }
}

G4Event() [3/3]

G4Event::G4Event ( const G4Event & )

delete

Member Function Documentation

AddPrimaryVertex()

void G4Event::AddPrimaryVertex ( G4PrimaryVertex * aPrimaryVertex )

inline

Definition at line 126 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 125 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();
    }
  }
}

FlagAsSubEvent()

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

inline

Definition at line 279 of file G4Event.hh.

    {
      motherEvent = me;
      subEventType = ty;
    }

GetDCofThisEvent()

G4DCofThisEvent * G4Event::GetDCofThisEvent ( ) const

inline

Definition at line 163 of file G4Event.hh.

      { return DC; }

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

GetEventID()

G4int G4Event::GetEventID ( ) const

inline

Definition at line 123 of file G4Event.hh.

      { return eventID; }

Referenced by G4VisManager::Draw(), G4Pevent::G4Pevent(), G4AdjointPrimaryGeneratorAction::GeneratePrimaries(), G4RTPrimaryGeneratorAction::GeneratePrimaries(), G4WorkerRunManager::ProcessOneEvent(), G4WorkerTaskRunManager::ProcessOneEvent(), G4SubEventTrackStack::PushToStack(), G4RTRun::RecordEvent(), G4SubEventTrackStack::ReleaseSubEvent(), G4PersistencyManager::Retrieve(), G4RunManager::rndmSaveThisEvent(), G4WorkerRunManager::rndmSaveThisEvent(), G4OpenGLSceneHandler::ScaledFlush(), G4PersistencyManager::Store(), and G4RunManager::UpdateScoring().

GetHCofThisEvent()

G4HCofThisEvent * G4Event::GetHCofThisEvent ( ) const

inline

Definition at line 161 of file G4Event.hh.

      { return HC; }

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

GetMotherEvent()

G4Event * G4Event::GetMotherEvent ( ) const

inline

Definition at line 284 of file G4Event.hh.

    { return motherEvent; }

GetNumberOfGrips()

G4int G4Event::GetNumberOfGrips ( ) const

inline

Definition at line 120 of file G4Event.hh.

      { return grips; }

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

GetNumberOfPrimaryVertex()

G4int G4Event::GetNumberOfPrimaryVertex ( ) const

inline

Definition at line 138 of file G4Event.hh.

      { return numberOfPrimaryVertex; }

GetNumberOfRemainingSubEvents()

G4int G4Event::GetNumberOfRemainingSubEvents ( ) const

inline

Definition at line 254 of file G4Event.hh.

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

Referenced by ToBeKept().

GetPrimaryVertex()

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

inline

Definition at line 142 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 182 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 190 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 286 of file G4Event.hh.

    { return subEventType; }

GetTrajectoryContainer()

G4TrajectoryContainer * G4Event::GetTrajectoryContainer ( ) const

inline

Definition at line 165 of file G4Event.hh.

      { return trajectoryContainer; }

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

GetUserInformation()

G4VUserEventInformation * G4Event::GetUserInformation ( ) const

inline

Definition at line 178 of file G4Event.hh.

      { return userInfo; }

Referenced by G4EventManager::GetUserInformation().

IsAborted()

G4bool G4Event::IsAborted ( ) const

inline

Definition at line 172 of file G4Event.hh.

{ return eventAborted; }

KeepForPostProcessing()

void G4Event::KeepForPostProcessing ( ) const

inline

Definition at line 109 of file G4Event.hh.

      { ++grips; }

KeepTheEvent()

void G4Event::KeepTheEvent ( G4bool vl = true )

inline

Definition at line 105 of file G4Event.hh.

      { keepTheEvent = vl; }

Referenced by G4EventManager::KeepTheCurrentEvent().

MergeSubEventResults()

void G4Event::MergeSubEventResults

(

const G4Event *

se

)

Definition at line 204 of file G4Event.cc.

{
#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
  // Note:
  //     - scores are merged directly to the scoring manager
  //     - hits collections should be merged by the user event action
}

Referenced by G4EventManager::TerminateSubEvent().

operator delete()

void G4Event::operator delete ( void * anEvent )

inline

Definition at line 301 of file G4Event.hh.

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

operator new()

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

inline

Definition at line 292 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 115 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 110 of file G4Event.cc.

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

PopSubEvent()

G4SubEvent * G4Event::PopSubEvent

(

G4int

ty

)

Definition at line 173 of file G4Event.cc.

{
  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;
}

Referenced by G4EventManager::PopSubEvent().

PostProcessingFinished()

void G4Event::PostProcessingFinished ( ) const

inline

Definition at line 111 of file G4Event.hh.

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

Print()

void G4Event::Print

(

)

const

Definition at line 120 of file G4Event.cc.

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

SetDCofThisEvent()

void G4Event::SetDCofThisEvent ( G4DCofThisEvent * value )

inline

Definition at line 89 of file G4Event.hh.

      { DC = value; }

Referenced by G4DigiManager::SetDigiCollection().

SetEventAborted()

void G4Event::SetEventAborted ( )

inline

Definition at line 93 of file G4Event.hh.

      { eventAborted = true; }

Referenced by G4RunManager::AbortEvent(), and G4RunManager::AbortRun().

SetEventID()

void G4Event::SetEventID ( G4int i )

inline

Definition at line 85 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 87 of file G4Event.hh.

      { HC = value; }

SetRandomNumberStatus()

void G4Event::SetRandomNumberStatus ( G4String & st )

inline

Definition at line 95 of file G4Event.hh.

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

Referenced by G4EventManager::ProcessOneEvent().

SetRandomNumberStatusForProcessing()

void G4Event::SetRandomNumberStatusForProcessing ( G4String & st )

inline

Definition at line 100 of file G4Event.hh.

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

SetTrajectoryContainer()

void G4Event::SetTrajectoryContainer ( G4TrajectoryContainer * value )

inline

Definition at line 91 of file G4Event.hh.

      { trajectoryContainer = value; }

SetUserInformation()

void G4Event::SetUserInformation ( G4VUserEventInformation * anInfo )

inline

Definition at line 176 of file G4Event.hh.

      { userInfo = anInfo; }

Referenced by G4EventManager::SetUserInformation().

SpawnSubEvent()

G4int G4Event::SpawnSubEvent

(

G4SubEvent *

se

)

Definition at line 189 of file G4Event.cc.

{
  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 158 of file G4Event.cc.

{
  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 G4SubEventTrackStack::PushToStack(), and G4SubEventTrackStack::ReleaseSubEvent().

TerminateSubEvent()

G4int G4Event::TerminateSubEvent

(

G4SubEvent *

se

)

Definition at line 219 of file G4Event.cc.

{
  auto ss = fSubEvtVector.find(se);
  if(ss==fSubEvtVector.end())
  {
    G4ExceptionDescription ed;
    ed << "Sub-event " << se << " of type " << se->GetSubEventType()
       << " with " << se->GetNTrack() << " tracks 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;
  return (G4int)fSubEvtVector.size();
}

ToBeKept()

G4bool G4Event::ToBeKept ( ) const

inline

Definition at line 107 of file G4Event.hh.

      { return keepTheEvent || GetNumberOfRemainingSubEvents()>0; }

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

---

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

• G4Event.hh
• G4Event.cc