GGSScoringManager Class Reference

Singleton for handling plugin scoring classes. More...

#include <GGSScoringManager.h>

Public Member Functions
	~GGSScoringManager ()
	Destructor.
void	RegisterSDClass (const G4String &className, G4VSensitiveDetector *(*sdBuilder)(G4String))
	Class registration method (class factory approach). More...
void	AddSDToLogVol (const G4String &sdClassName, const G4String &logVolNameAndParams)
	Adds a sensitive detector to a logical volume (class factory approach). More...
void	AddSDToLogVol (G4VSensitiveDetector *sd, G4LogicalVolume *logVol)
	Adds a sensitive detector to a logical volume (user build approach). More...
GGSScoringManagerMessenger *	GetMessenger ()
	Getter for messenger.

Static Public Member Functions
static GGSScoringManager &	GetInstance ()
	Singleton getter. More...

Detailed Description

Singleton for handling plugin scoring classes.

This singleton manages the assignment of multiple sensitive detectors to a logical volume. The sensitive detectors can be provided by the user (user build approach) or be built by the singleton itself (class factory approach) in a messenger-driven way.

Definition at line 26 of file GGSScoringManager.h.

Member Function Documentation

void GGSScoringManager::AddSDToLogVol	(	const G4String &	sdClassName,
		const G4String &	logVolNameAndParams
	)

Adds a sensitive detector to a logical volume (class factory approach).

This method adds a new sensitive detector to a logical volume. It can be called multiple times for each logical volume to add more sd to the same volume. The logical volume is specified by a string containing its name plus an eventual additional trailing string separated by a space and containing the parameters to initialize the sensitive detector. The format and the handling of the parameters are defined by the given sensitive detector.

Parameters

sdClassName	The name of the sd class.
logVolNameAndParams	The name of the logical volume, eventually followed by parameters.

See Also

GGSScorer

Definition at line 48 of file GGSScoringManager.cpp.

                                                                                                      {
  static const std::string routineName("GGSScoringManager::AddSDToLogVol");

  G4VSensitiveDetector *sd = nullptr;

  // Attach the sensitive detector to all the logical volumes
  G4String logVolName = logVolNameAndParams.substr(0, logVolNameAndParams.find_first_of(' '));
  auto separatorPos = logVolNameAndParams.find_first_of(' ');
  G4String params;
  if (separatorPos != std::string::npos) {
    params = logVolNameAndParams.substr(logVolNameAndParams.find_first_of(' ') + 1);
  }
  for (G4LogicalVolumeStore::const_iterator logVol = G4LogicalVolumeStore::GetInstance()->begin();
       logVol != G4LogicalVolumeStore::GetInstance()->end(); logVol++) {
    if ((*logVol)->GetName() == logVolName) {
      // Retrieve the sd builder
      if (!sd) {
        SDBuildersMap::iterator builder = _buildersMap.find(sdClassName);
        if (builder == _buildersMap.end()) {
          throw std::runtime_error(routineName + ": builder for sensitive detector class " + sdClassName +
                                   " is not present.");
        }
        // Build the sd
        G4String sdName = sdClassName;
        if (params != "") {
          sdName.append('.').append(params);
        }
        sd = builder->second(logVolName + "." + sdName);
      }
      // Add sd to logvol
      AddSDToLogVol(sd, *logVol);
    }
  }

  if (!sd) {
    throw std::runtime_error(routineName + ": logical volume " + logVolName + " not present. Sensitive detector " +
                             sdClassName + " not added.");
  }
}

void GGSScoringManager::AddSDToLogVol	(	G4VSensitiveDetector *	sd,
		G4LogicalVolume *	logVol
	)

Adds a sensitive detector to a logical volume (user build approach).

This method adds a new sensitive detector to a logical volume. It can be called multiple times for each logical volume to add more sd to the same volume.

Parameters

sd	Pointer to the sensitive detector.
logVol	Pointer to the logical volume.

Definition at line 90 of file GGSScoringManager.cpp.

                                                                                       {

  // Add sd to logical volume
  if (logVol->GetSensitiveDetector() == NULL) {
    // Case 1: logical has not a sd. Add the newly built sd to it
    logVol->SetSensitiveDetector(sd);
  } else {
    GGSMultiSensitiveDetector *multiSD = dynamic_cast<GGSMultiSensitiveDetector *>(logVol->GetSensitiveDetector());
    if (multiSD) {
      // Case 2: the current sd is a multisd. Add the newly built sd to it
      multiSD->AddSensitiveDetector(sd);
    } else {
      // Case 3: the current sd is a standard sd. Replace it with a multisd and add it and the newly built sd to the
      // multisd
      multiSD = new GGSMultiSensitiveDetector(G4String(logVol->GetName()).append(".GGSMultiSD"));
      multiSD->AddSensitiveDetector(logVol->GetSensitiveDetector());
      multiSD->AddSensitiveDetector(sd);
      G4SDManager::GetSDMpointer()->AddNewDetector(multiSD);
      logVol->SetSensitiveDetector(multiSD);
    }
  }

  // Add the sd to the sdmanager if it has not already been added
  GGSSmartLog::MuteOutput();
  if (G4SDManager::GetSDMpointer()->GetCollectionID(sd->GetName()) == -1) {
    G4SDManager::GetSDMpointer()->AddNewDetector(sd);
  }
  GGSSmartLog::UnmuteOutput();
}

GGSScoringManager & GGSScoringManager::GetInstance ( )

static

Singleton getter.

Returns

Reference to the scoring manager.

Definition at line 22 of file GGSScoringManager.cpp.

                                                  {
  static GGSScoringManager instance;
  return instance;
}

void GGSScoringManager::RegisterSDClass	(	const G4String &	className,
		G4VSensitiveDetector *(*)(G4String)	sdBuilder
	)

Class registration method (class factory approach).

Parameters

className	The name of the sd class to be registered.
sdBuilder	Builder function for sd class.

Definition at line 37 of file GGSScoringManager.cpp.

                                                                                                               {
  static const std::string routineName("GGSScoringManager::RegisterSDClass");
  std::pair<SDBuildersMap::iterator, bool> insertResult =
      _buildersMap.insert(std::pair<G4String, G4VSensitiveDetector *(*)(G4String)>(className, sdBuilder));
  if (!insertResult.second) {
    COUT(WARNING) << "Sensitive detector class " << className << " is already present." << ENDL;
  }
}

---

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

• GGSScoringManager.h
• GGSScoringManager.cpp