genie::flux::GFlavorMixerFactory Class Reference

A class for generating concrete GFlavorMixerI derived classes based on the factory pattern. This code supplies a CPP macro which allows the classes to self-register and thus no modification of this class is needed in order to expand the list of classes it knows about. More...

#include <GFlavorMixerFactory.h>

Collaboration diagram for genie::flux::GFlavorMixerFactory:

Classes
struct	Cleaner

Public Member Functions
genie::flux::GFlavorMixerI *	GetFlavorMixer (const std::string &)
bool	IsKnownFlavorMixer (const std::string &)
const std::vector< std::string > &	AvailableFlavorMixers () const
bool	RegisterCreator (std::string name, GFlavorMixerICtorFuncPtr_t ctorptr, bool *ptr)

Static Public Member Functions
static GFlavorMixerFactory &	Instance ()

Private Member Functions
	GFlavorMixerFactory ()
virtual	~GFlavorMixerFactory ()
	GFlavorMixerFactory (const GFlavorMixerFactory &)
void	operator= (const GFlavorMixerFactory &)

Private Attributes
std::map< std::string, GFlavorMixerICtorFuncPtr_t >	fFunctionMap
std::map< std::string, bool * >	fBoolPtrMap
std::vector< std::string >	listnames

Static Private Attributes
static GFlavorMixerFactory *	fgTheInstance

Friends
struct	Cleaner

Detailed Description

A class for generating concrete GFlavorMixerI derived classes based on the factory pattern. This code supplies a CPP macro which allows the classes to self-register and thus no modification of this class is needed in order to expand the list of classes it knows about.

Implemented as a singleton holding a map between names and pointers-to-functions (that call a class default constructor). The functions pointers must return GFlavorMixerI*.

Author

Robert Hatcher <rhatcher \at fnal.gov> Fermi National Accelerator Laboratory

Created:\n

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 43 of file GFlavorMixerFactory.h.

Constructor & Destructor Documentation

GFlavorMixerFactory() [1/2]

genie::flux::GFlavorMixerFactory::GFlavorMixerFactory ( )

private

Definition at line 20 of file GFlavorMixerFactory.cxx.

{
  fgTheInstance = this;   // record created self in static pointer
}

References fgTheInstance.

Referenced by GFlavorMixerFactory(), Instance(), and operator=().

~GFlavorMixerFactory()

genie::flux::GFlavorMixerFactory::~GFlavorMixerFactory ( )

privatevirtual

Definition at line 25 of file GFlavorMixerFactory.cxx.

{
  fgTheInstance = 0;
}

References fgTheInstance.

GFlavorMixerFactory() [2/2]

genie::flux::GFlavorMixerFactory::GFlavorMixerFactory ( const GFlavorMixerFactory & )

private

References GFlavorMixerFactory().

Member Function Documentation

AvailableFlavorMixers()

const std::vector< std::string > & genie::flux::GFlavorMixerFactory::AvailableFlavorMixers

(

)

const

Definition at line 76 of file GFlavorMixerFactory.cxx.

{
  // list of names might be out of date due to new registrations
  // rescan the std::map on each call (which won't be frequent)
  listnames.clear();
 
  // scan map for registered names
  std::map<std::string, GFlavorMixerICtorFuncPtr_t>::const_iterator itr;
  for ( itr = fFunctionMap.begin(); itr != fFunctionMap.end(); ++itr )
    listnames.push_back(itr->first);
 
  return listnames;
}

References fFunctionMap, and listnames.

GetFlavorMixer()

GFlavorMixerI * genie::flux::GFlavorMixerFactory::GetFlavorMixer

(

const std::string &

name

)

Definition at line 45 of file GFlavorMixerFactory.cxx.

{
  GFlavorMixerI* p = 0;
 
  // we don't want map creating an entry if it doesn't exist
  // so use map::find() not map::operator[]
  std::map<std::string, GFlavorMixerICtorFuncPtr_t>::iterator itr
    = fFunctionMap.find(name);
  if ( fFunctionMap.end() != itr ) {
    // found an appropriate entry in the list
    GFlavorMixerICtorFuncPtr_t foo = itr->second;  // this is the function
    p = (*foo)();  // use function to create the GFlavorMixerI
  }
  if ( ! p ) {
    LOG("Flux",pWARN) << "### GFlavorMixerFactory WARNING: "
                      << "GFlavorMixerI " << name << " is not known";
  }
  return p;
}

References fFunctionMap, LOG, and pWARN.

Instance()

GFlavorMixerFactory & genie::flux::GFlavorMixerFactory::Instance ( )

static

Definition at line 30 of file GFlavorMixerFactory.cxx.

{
  // Cleaner dtor calls GFlavorMixerFactory dtor at job end
  static Cleaner cleaner;
 
  if ( ! fgTheInstance ) {
    // need to create one
    cleaner.UseMe();   // dummy call to quiet compiler warnings
    fgTheInstance = new GFlavorMixerFactory();
  }
 
  return *fgTheInstance;
}

References fgTheInstance, GFlavorMixerFactory(), and genie::flux::GFlavorMixerFactory::Cleaner::UseMe().

IsKnownFlavorMixer()

bool genie::flux::GFlavorMixerFactory::IsKnownFlavorMixer

(

const std::string &

name

)

Definition at line 65 of file GFlavorMixerFactory.cxx.

{
  //  check if we know the name
  bool res = false;
  std::map<std::string, GFlavorMixerICtorFuncPtr_t>::iterator itr
    = fFunctionMap.find(name);
  if ( fFunctionMap.end() != itr ) res = true;
  return res;
}

References fFunctionMap.

operator=()

void genie::flux::GFlavorMixerFactory::operator= ( const GFlavorMixerFactory & )

private

References GFlavorMixerFactory().

RegisterCreator()

bool genie::flux::GFlavorMixerFactory::RegisterCreator	(	std::string	name,
		GFlavorMixerICtorFuncPtr_t	ctorptr,
		bool *	ptr )

Definition at line 90 of file GFlavorMixerFactory.cxx.

{
  // record new functions for creating processes
  fFunctionMap[name] = foo;
  fBoolPtrMap[name]  = boolptr;
  return true;
}

References fBoolPtrMap, and fFunctionMap.

Friends And Related Symbol Documentation

Cleaner

friend struct Cleaner

friend

Definition at line 97 of file GFlavorMixerFactory.h.

Member Data Documentation

fBoolPtrMap

std::map<std::string, bool*> genie::flux::GFlavorMixerFactory::fBoolPtrMap

private

Definition at line 69 of file GFlavorMixerFactory.h.

Referenced by RegisterCreator().

fFunctionMap

std::map<std::string, GFlavorMixerICtorFuncPtr_t> genie::flux::GFlavorMixerFactory::fFunctionMap

private

Definition at line 66 of file GFlavorMixerFactory.h.

Referenced by AvailableFlavorMixers(), GetFlavorMixer(), IsKnownFlavorMixer(), and RegisterCreator().

fgTheInstance

GFlavorMixerFactory * genie::flux::GFlavorMixerFactory::fgTheInstance

staticprivate

Definition at line 63 of file GFlavorMixerFactory.h.

Referenced by GFlavorMixerFactory(), Instance(), genie::flux::GFlavorMixerFactory::Cleaner::~Cleaner(), and ~GFlavorMixerFactory().

listnames

std::vector<std::string> genie::flux::GFlavorMixerFactory::listnames

mutableprivate

Definition at line 71 of file GFlavorMixerFactory.h.

Referenced by AvailableFlavorMixers().

---

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

• GFlavorMixerFactory.h
• GFlavorMixerFactory.cxx