genie::AlgId Class Reference

Algorithm ID (algorithm name + configuration set name) More...

#include <AlgId.h>

Collaboration diagram for genie::AlgId:

Public Member Functions
	AlgId ()
	AlgId (string name, string config)
	AlgId (const AlgId &id)
	AlgId (const RgAlg &registry_item)
	~AlgId ()
string	Name (void) const
string	Config (void) const
string	Key (void) const
void	SetId (string name, string config="")
void	SetName (string name)
void	SetConfig (string config)
void	Copy (const AlgId &id)
void	Copy (const RgAlg &registry_item)
void	Print (ostream &stream) const

Private Member Functions
void	Init (void)
void	UpdateKey (void)

Private Attributes
string	fName
	Algorithm name (including namespaces) More...
string	fConfig
	Configuration set name. More...
string	fKey
	Unique key: namespace::alg_name/alg_config. More...

Friends
ostream &	operator<< (ostream &stream, const AlgId &alg)

Detailed Description

Algorithm ID (algorithm name + configuration set name)

Author

Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool

Created:

October 20, 2005

License:

Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 34 of file AlgId.h.

Constructor & Destructor Documentation

AlgId::AlgId

(

)

Definition at line 29 of file AlgId.cxx.

References Init().

{
  this->Init();
}

AlgId::AlgId	(	string	name,
		string	config
	)

Definition at line 34 of file AlgId.cxx.

References SetId().

{
  this->SetId(name,config);
}

AlgId::AlgId

(

const AlgId &

id

)

Definition at line 39 of file AlgId.cxx.

References Copy().

{
  this->Copy(id);
}

AlgId::AlgId

(

const RgAlg &

registry_item

)

Definition at line 44 of file AlgId.cxx.

References Copy().

{
  this->Copy(registry_item);
}

AlgId::~AlgId

(

)

Definition at line 49 of file AlgId.cxx.

{

}

Member Function Documentation

string genie::AlgId::Config ( void  ) const

inline

Definition at line 45 of file AlgId.h.

References fConfig.

Referenced by genie::AlgFactory::AdoptAlgorithm(), genie::XSecSplineList::BuildSplineKey(), genie::Algorithm::Compare(), genie::AlgFactory::ForceReconfiguration(), genie::AlgFactory::GetAlgorithm(), SetName(), TestPythiaTauDecays(), and UpdateKey().

{ return fConfig; }

void AlgId::Copy

(

const AlgId &

id

)

Definition at line 72 of file AlgId.cxx.

References fConfig, fName, and UpdateKey().

Referenced by AlgId().

{
  this->fName   = id.Name();
  this->fConfig = id.Config();

  this->UpdateKey();
}

void AlgId::Copy

(

const RgAlg &

registry_item

)

Definition at line 80 of file AlgId.cxx.

References RgAlg::config, fConfig, fName, RgAlg::name, and UpdateKey().

{
  this->fName   = registry_item.name;
  this->fConfig = registry_item.config;

  this->UpdateKey();
}

void AlgId::Init ( void  )

private

Definition at line 103 of file AlgId.cxx.

References fConfig, fKey, and fName.

Referenced by AlgId().

{
  this->fName   = "";
  this->fConfig = "";
  this->fKey    = "";
}

string genie::AlgId::Key ( void  ) const

inline

Definition at line 46 of file AlgId.h.

References fKey.

Referenced by genie::KineGeneratorWithCache::AccessCacheBranch(), genie::InteractionListAssembler::AssembleInteractionList(), genie::XSecAlgorithmMap::BuildMap(), genie::InteractionGeneratorMap::BuildMap(), genie::ReinSehgalRESXSecWithCache::CacheBranchName(), genie::DISXSec::CacheBranchName(), genie::DMDISXSec::CacheBranchName(), genie::ReinSehgalRESXSecWithCacheFast::CacheBranchName(), genie::SPPXSecWithCache::CacheBranchName(), genie::Algorithm::Configure(), genie::GEVGDriver::CreateSplines(), genie::KNOTunedQPMDISPXSec::DISRESJoinSuppressionFactor(), genie::AlgConfigPool::FindRegistry(), genie::GEVGDriver::GenerateEvent(), genie::QPMDISPXSec::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), genie::EventGenerator::LoadConfig(), genie::EventGeneratorListAssembler::LoadGenerator(), main(), Print(), genie::XSecAlgorithmMap::Print(), genie::InteractionGeneratorMap::Print(), genie::EventGenerator::ProcessEventRecord(), and genie::GEVGDriver::UseSplines().

{ return fKey;    }

string genie::AlgId::Name ( void  ) const

inline

Definition at line 44 of file AlgId.h.

References fName.

Referenced by genie::AlgFactory::AdoptAlgorithm(), genie::XSecSplineList::BuildSplineKey(), genie::Algorithm::Compare(), genie::COHKinematicsGenerator::ComputeMaxXSec(), genie::AlgFactory::GetAlgorithm(), genie::LwlynSmithQELCCPXSec::Integral(), genie::NievesQELCCPXSec::Integral(), genie::COHXSec::Integrate(), genie::COHPrimaryLeptonGenerator::ProcessEventRecord(), genie::COHHadronicSystemGenerator::ProcessEventRecord(), genie::COHKinematicsGenerator::ProcessEventRecord(), genie::MECGenerator::ProcessEventRecord(), SetConfig(), TestPythiaTauDecays(), and UpdateKey().

{ return fName;   }

void AlgId::Print

(

ostream &

stream

)

const

Definition at line 88 of file AlgId.cxx.

References Key().

Referenced by genie::operator<<().

{
  stream << this->Key();
}

void AlgId::SetConfig

(

string

config

)

Definition at line 59 of file AlgId.cxx.

References Name(), and SetId().

{
  this->SetId(this->Name(), config);
}

void AlgId::SetId	(	string	name,
		string	config = ""
	)

Definition at line 64 of file AlgId.cxx.

References fConfig, fName, and UpdateKey().

Referenced by AlgId(), SetConfig(), and SetName().

{
  this->fName   = name;
  this->fConfig = config;

  this->UpdateKey();
}

void AlgId::SetName

(

string

name

)

Definition at line 54 of file AlgId.cxx.

References Config(), and SetId().

{
  this->SetId(name, this->Config());
}

void AlgId::UpdateKey ( void  )

private

Definition at line 93 of file AlgId.cxx.

References Config(), fKey, and Name().

Referenced by Copy(), and SetId().

{
  ostringstream key;

  key << this->Name();
  if(this->Config().size() > 0) key << "/" << this->Config();

  fKey = key.str();
}

Friends And Related Function Documentation

ostream& operator<< ( ostream &  stream, const AlgId &  alg  )

friend

Definition at line 22 of file AlgId.cxx.

  {
    algid.Print(stream);
    return stream;
  }

Member Data Documentation

string genie::AlgId::fConfig

private

Configuration set name.

Definition at line 63 of file AlgId.h.

Referenced by Config(), Copy(), Init(), and SetId().

string genie::AlgId::fKey

private

Unique key: namespace::alg_name/alg_config.

Definition at line 64 of file AlgId.h.

Referenced by Init(), Key(), and UpdateKey().

string genie::AlgId::fName

private

Algorithm name (including namespaces)

Definition at line 62 of file AlgId.h.

Referenced by Copy(), Init(), Name(), and SetId().

---

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

• AlgId.h
• AlgId.cxx