G4ParameterManager Class Reference

#include <G4ParameterManager.hh>

Collaboration diagram for G4ParameterManager:

Public Member Functions
	G4ParameterManager (G4bool isMaster=true)
virtual	~G4ParameterManager ()
template<typename T >
void	CreateParameter (const G4String &name, T value, G4MergeMode mergeMode=G4MergeMode::kAddition)
template<typename T >
void	RegisterParameter (G4Parameter< T > &parameter)
template<typename T >
G4Parameter< T > *	GetParameter (const G4String &name, G4bool warn=true) const
void	RegisterParameter (G4VParameter *parameter)
G4VParameter *	GetParameter (const G4String &name, G4bool warn=true) const
void	Merge ()
void	Reset ()

Static Public Member Functions
static G4ParameterManager *	Instance ()

Private Attributes
const G4AnalysisManagerState	fState
std::map< G4String, G4VParameter * >	fMap
std::vector< G4VParameter * >	fParametersToDelete

Static Private Attributes
static G4ParameterManager *	fgMasterInstance = nullptr
static G4ThreadLocal G4ParameterManager *	fgInstance = nullptr

Detailed Description

Definition at line 45 of file G4ParameterManager.hh.

Constructor & Destructor Documentation

G4ParameterManager()

G4ParameterManager::G4ParameterManager

(

G4bool

isMaster = true

)

Definition at line 56 of file G4ParameterManager.cc.

 : fState("Parameter", isMaster),
   fMap() 
{
  if ( ( isMaster && fgMasterInstance ) || ( fgInstance ) ) {
    G4ExceptionDescription description;
    description 
      << "      " 
      << "G4ParameterAnalysisManager already exists." 
      << "Cannot create another instance.";
    G4Exception("G4ParameterAnalysisManager::G4ParameterAnalysisManager()",
                "Analysis_F001", FatalException, description);
  }
  if ( isMaster ) fgMasterInstance = this;
  fgInstance = this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

~G4ParameterManager()

G4ParameterManager::~G4ParameterManager ( )

virtual

Definition at line 74 of file G4ParameterManager.cc.

{
  // delete only parameters create by the mager itself
  for ( auto it : fParametersToDelete ) {
    delete it;
  }
}

Member Function Documentation

CreateParameter()

template<typename T >

void G4ParameterManager::CreateParameter	(	const G4String &	name,
		T	value,
		G4MergeMode	mergeMode = G4MergeMode::kAddition
	)

GetParameter() [1/2]

template<typename T >

G4Parameter<T>* G4ParameterManager::GetParameter	(	const G4String &	name,
		G4bool	warn = true
	)		const

GetParameter() [2/2]

G4VParameter * G4ParameterManager::GetParameter	(	const G4String &	name,
		G4bool	warn = true
	)		const

Definition at line 94 of file G4ParameterManager.cc.

{
  // get G4VParammeter from the map
  auto it = fMap.find(name);
  if ( it == fMap.end() ) {
    if ( warn) {
      G4ExceptionDescription description;
      description << "      " << "parameter " << name << " does not exist.";
      G4Exception("G4ParameterManager::GetParameter", 
                  "Analysis_W011", JustWarning, description);
    }
    return 0;
  }

  return it->second;
}

Here is the call graph for this function:

Instance()

G4ParameterManager * G4ParameterManager::Instance ( void  )

static

Definition at line 45 of file G4ParameterManager.cc.

{
  if ( fgInstance == nullptr ) {
    G4bool isMaster = ! G4Threading::IsWorkerThread();
    fgInstance = new G4ParameterManager(isMaster);
  }
  
  return fgInstance;
}    

Here is the call graph for this function:

Here is the caller graph for this function:

Merge()

void G4ParameterManager::Merge

(

)

Definition at line 119 of file G4ParameterManager.cc.

{
  // Do nothing if  there are no parameters registered
  // or if master thread
  if ( (! fMap.size()) ||  (! G4Threading::IsWorkerThread()) ) return;

  // The manager on mastter must exist
  if ( ! fgMasterInstance ) {
    G4ExceptionDescription description;
    description 
      << "      " << "No master G4ParameterManager instance exists." 
      << G4endl 
      << "      " << "Parameters will not be merged.";
      G4Exception("G4ParameterManager::Merge()",
                "Analysis_W031", JustWarning, description);
    return;
  }

  // The worker manager just merges its parameters to the master
  // This operation needs a lock
  G4cout << "Go to merge parameters" << G4endl; 
  G4AutoLock lock(&mergeMutex);

  // the other manager has the map with identical keys
  auto it = fMap.begin();
  for ( auto itMaster : fgMasterInstance->fMap ) {
    // G4VParameter* parameter = (it++)->second;
    // G4VParameter* masterParameter = itMaster->second;
    // masterParameter->Merge(*(parameter));
    itMaster.second->Merge(*((it++)->second));
  }  
  lock.unlock();
}

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterParameter() [1/2]

template<typename T >

void G4ParameterManager::RegisterParameter

(

G4Parameter< T > &

parameter

)

Here is the caller graph for this function:

RegisterParameter() [2/2]

void G4ParameterManager::RegisterParameter

(

G4VParameter *

parameter

)

Definition at line 87 of file G4ParameterManager.cc.

{
  fMap[parameter->GetName()] = parameter;
}

Here is the call graph for this function:

Reset()

void G4ParameterManager::Reset

(

)

Definition at line 154 of file G4ParameterManager.cc.

{
// Reset histograms and profiles
  
  for ( auto it : fMap ) {
    it.second->Reset();
  }  
}  

Here is the caller graph for this function:

Member Data Documentation

fgInstance

G4ThreadLocal G4ParameterManager * G4ParameterManager::fgInstance = nullptr

staticprivate

Definition at line 83 of file G4ParameterManager.hh.

fgMasterInstance

G4ParameterManager * G4ParameterManager::fgMasterInstance = nullptr

staticprivate

Definition at line 82 of file G4ParameterManager.hh.

fMap

std::map<G4String, G4VParameter*> G4ParameterManager::fMap

private

Definition at line 87 of file G4ParameterManager.hh.

fParametersToDelete

std::vector<G4VParameter*> G4ParameterManager::fParametersToDelete

private

Definition at line 88 of file G4ParameterManager.hh.

fState

const G4AnalysisManagerState G4ParameterManager::fState

private

Definition at line 86 of file G4ParameterManager.hh.

---

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

• G4ParameterManager.hh
• G4ParameterManager.cc