genie::AlgId Class Reference

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

#include <AlgId.h>

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)
string	fConfig
	Configuration set name.
string	fKey
	Unique key: namespace::alg_name/alg_config.

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

Detailed Description

Algorithm ID (algorithm name + configuration set name)

Author

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

Created:\n October 20, 2005

License:\n Copyright (c) 2003-2025, 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() [1/4]

AlgId::AlgId

(

)

Definition at line 29 of file AlgId.cxx.

{
  this->Init();
}

References Init().

Referenced by AlgId(), Copy(), and operator<<.

AlgId() [2/4]

AlgId::AlgId	(	string	name,
		string	config )

Definition at line 34 of file AlgId.cxx.

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

References SetId().

AlgId() [3/4]

AlgId::AlgId

(

const AlgId &

id

)

Definition at line 39 of file AlgId.cxx.

{
  this->Copy(id);
}

References AlgId(), and Copy().

AlgId() [4/4]

AlgId::AlgId

(

const RgAlg &

registry_item

)

Definition at line 44 of file AlgId.cxx.

{
  this->Copy(registry_item);
}

References Copy().

~AlgId()

AlgId::~AlgId

(

)

Definition at line 49 of file AlgId.cxx.

{
 
}

Member Function Documentation

Config()

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

inline

Definition at line 45 of file AlgId.h.

{ return fConfig; }

References fConfig.

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

Copy() [1/2]

void AlgId::Copy

(

const AlgId &

id

)

Definition at line 72 of file AlgId.cxx.

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

References AlgId(), fConfig, fName, and UpdateKey().

Referenced by AlgId(), and AlgId().

Copy() [2/2]

void AlgId::Copy

(

const RgAlg &

registry_item

)

Definition at line 80 of file AlgId.cxx.

{
  this->fName   = registry_item.name;
  this->fConfig = registry_item.config;
 
  this->UpdateKey();
}

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

Init()

void AlgId::Init ( void )

private

Definition at line 103 of file AlgId.cxx.

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

References fConfig, fKey, and fName.

Referenced by AlgId().

Key()

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

inline

Definition at line 46 of file AlgId.h.

{ return fKey;    }

References fKey.

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

Name()

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

inline

Definition at line 44 of file AlgId.h.

{ return fName;   }

References fName.

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

Print()

void AlgId::Print

(

ostream &

stream

)

const

Definition at line 88 of file AlgId.cxx.

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

References Key().

Referenced by operator<<.

SetConfig()

void AlgId::SetConfig

(

string

config

)

Definition at line 59 of file AlgId.cxx.

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

References Name(), and SetId().

SetId()

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

Definition at line 64 of file AlgId.cxx.

{
  this->fName   = name;
  this->fConfig = config;
 
  this->UpdateKey();
}

References fConfig, fName, and UpdateKey().

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

SetName()

void AlgId::SetName

(

string

name

)

Definition at line 54 of file AlgId.cxx.

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

References Config(), and SetId().

UpdateKey()

void AlgId::UpdateKey ( void )

private

Definition at line 93 of file AlgId.cxx.

{
  ostringstream key;
 
  key << this->Name();
  if(this->Config().size() > 0) key << "/" << this->Config();
 
  fKey = key.str();
}

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

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

Friends And Related Symbol Documentation

operator<<

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

friend

Definition at line 22 of file AlgId.cxx.

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

References AlgId(), and Print().

Member Data Documentation

fConfig

string genie::AlgId::fConfig

private

Configuration set name.

Definition at line 63 of file AlgId.h.

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

fKey

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().

fName

string genie::AlgId::fName

private

Algorithm name (including namespaces)

Definition at line 62 of file AlgId.h.

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

---

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

• AlgId.h
• AlgId.cxx