TrackInformationExtractor Class Reference

#include <TrackInformationExtractor.h>

Public Member Functions
const TrackInformation &	operator() (const G4Track &gtk) const
const TrackInformation &	operator() (const G4Track *gtk) const
TrackInformation &	operator() (G4Track &gtk) const
TrackInformation &	operator() (G4Track *gtk) const

Private Member Functions
void	missing (const G4Track &gtk) const
void	wrongType () const

Detailed Description

Provides safe access to the TrackInformation part of a G4Track. If the G4Track pointer/reference is const, a const reference to the TrackInformation is returned, else a non-const reference is returned. The TrackInformationExtractor checks for the existance of TrackInformation and for the validity of the dynamic_cast; It will throw an excepton if it is not possible to return TrackInformation, but it will do it's best to satisfy the request (in some cases it may even create the TrackInformation on-the-fly).

Definition at line 19 of file TrackInformationExtractor.h.

Member Function Documentation

missing()

void TrackInformationExtractor::missing ( const G4Track &  gtk ) const

private

Definition at line 29 of file TrackInformationExtractor.cc.

Referenced by operator()().

                                                             {
  G4Exception(
      "SimG4Core/Notification", "mc001", FatalException, "TrackInformationExtractor: G4Track has no TrackInformation");
}

operator()() [1/4]

const TrackInformation & TrackInformationExtractor::operator()

(

const G4Track &

gtk

)

const

for a const G4Track pointer/reference a const TrackInformation& is returned.

Definition at line 5 of file TrackInformationExtractor.cc.

References missing(), suppress, and wrongType().

                                                                                      {
  G4VUserTrackInformation *gui = gtk.GetUserInformation();
  const TrackInformation *tkInfo = dynamic_cast<const TrackInformation *>(gui);
  if (gui == nullptr) {
    missing(gtk);
  } else if (tkInfo == nullptr) {
    wrongType();
  }
  // Silence Clang analyzer warning: G4Exception will be thrown if tkInfo is null
  [[clang::suppress]] return *tkInfo;
}

operator()() [2/4]

const TrackInformation& TrackInformationExtractor::operator() ( const G4Track *  gtk ) const

inline

Definition at line 25 of file TrackInformationExtractor.h.

References operator()().

Referenced by operator()().

{ return operator()(*gtk); }

operator()() [3/4]

TrackInformation & TrackInformationExtractor::operator()

(

G4Track &

gtk

)

const

for a non-const G4Track pointer/reference the TrackInformation& is also non-const.

Definition at line 17 of file TrackInformationExtractor.cc.

References missing(), suppress, and wrongType().

                                                                          {
  G4VUserTrackInformation *gui = gtk.GetUserInformation();
  TrackInformation *tkInfo = dynamic_cast<TrackInformation *>(gui);
  if (gui == nullptr) {
    missing(gtk);
  } else if (tkInfo == nullptr) {
    wrongType();
  }
  // Silence Clang analyzer warning: G4Exception will be thrown if tkInfo is null
  [[clang::suppress]] return *tkInfo;
}

operator()() [4/4]

TrackInformation& TrackInformationExtractor::operator() ( G4Track *  gtk ) const

inline

Definition at line 30 of file TrackInformationExtractor.h.

References operator()().

Referenced by operator()().

{ return operator()(*gtk); }

wrongType()

void TrackInformationExtractor::wrongType ( ) const

private

Definition at line 34 of file TrackInformationExtractor.cc.

Referenced by operator()().

                                                {
  G4Exception(
      "SimG4Core/Notification", "mc001", FatalException, "User information in G4Track is not of TrackInformation type");
}