genie::flux::GFluxDriverFactory Class Reference

A class for generating concrete GFluxI 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 <GFluxDriverFactory.h>

Collaboration diagram for genie::flux::GFluxDriverFactory:

Classes
struct	Cleaner

Public Member Functions
genie::GFluxI *	GetFluxDriver (const std::string &)
bool	IsKnownFluxDriver (const std::string &)
const std::vector< std::string > &	AvailableFluxDrivers () const
bool	RegisterCreator (std::string name, GFluxICtorFuncPtr_t ctorptr, bool *ptr)
void	PrintConfig () const

Static Public Member Functions
static GFluxDriverFactory &	Instance ()

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

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

Static Private Attributes
static GFluxDriverFactory *	fgTheInstance

Friends
struct	Cleaner

Detailed Description

A class for generating concrete GFluxI 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 GFluxI*.

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 46 of file GFluxDriverFactory.h.

Constructor & Destructor Documentation

GFluxDriverFactory() [1/2]

genie::flux::GFluxDriverFactory::GFluxDriverFactory ( )

private

Definition at line 23 of file GFluxDriverFactory.cxx.

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

References fgTheInstance.

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

~GFluxDriverFactory()

genie::flux::GFluxDriverFactory::~GFluxDriverFactory ( )

privatevirtual

Definition at line 28 of file GFluxDriverFactory.cxx.

{
  fgTheInstance = 0;
}

References fgTheInstance.

GFluxDriverFactory() [2/2]

genie::flux::GFluxDriverFactory::GFluxDriverFactory ( const GFluxDriverFactory & )

private

References GFluxDriverFactory().

Member Function Documentation

AvailableFluxDrivers()

const std::vector< std::string > & genie::flux::GFluxDriverFactory::AvailableFluxDrivers

(

)

const

Definition at line 79 of file GFluxDriverFactory.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, GFluxICtorFuncPtr_t>::const_iterator itr;
  for ( itr = fFunctionMap.begin(); itr != fFunctionMap.end(); ++itr )
    listnames.push_back(itr->first);
 
  return listnames;
}

References fFunctionMap, and listnames.

Referenced by main(), and PrintConfig().

GetFluxDriver()

GFluxI * genie::flux::GFluxDriverFactory::GetFluxDriver

(

const std::string &

name

)

Definition at line 48 of file GFluxDriverFactory.cxx.

{
  GFluxI* 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, GFluxICtorFuncPtr_t>::iterator itr
    = fFunctionMap.find(name);
  if ( fFunctionMap.end() != itr ) {
    // found an appropriate entry in the list
    GFluxICtorFuncPtr_t foo = itr->second;  // this is the function
    p = (*foo)();  // use function to create the GFluxI
  }
  if ( ! p ) {
    LOG("Flux",pWARN) << "### GFluxDriverFactory WARNING: "
                      << "GFluxI " << name << " is not known";
  }
  return p;
}

References fFunctionMap, LOG, and pWARN.

Referenced by main().

Instance()

GFluxDriverFactory & genie::flux::GFluxDriverFactory::Instance ( )

static

Definition at line 33 of file GFluxDriverFactory.cxx.

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

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

Referenced by main().

IsKnownFluxDriver()

bool genie::flux::GFluxDriverFactory::IsKnownFluxDriver

(

const std::string &

name

)

Definition at line 68 of file GFluxDriverFactory.cxx.

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

References fFunctionMap.

operator=()

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

private

References GFluxDriverFactory().

PrintConfig()

void genie::flux::GFluxDriverFactory::PrintConfig

(

)

const

Definition at line 103 of file GFluxDriverFactory.cxx.

{
  const std::vector<std::string>& avail = AvailableFluxDrivers();
  size_t n = avail.size();
  std::cout << "GFluxDriverFactory has the following drivers registered:"
            << std::endl;
  for (size_t i=0; i<n; ++i) {
    std::cout << "  [" << std::setw(3) << i << "]  "
              << avail[i] << std::endl;
  }
}

References AvailableFluxDrivers().

RegisterCreator()

bool genie::flux::GFluxDriverFactory::RegisterCreator	(	std::string	name,
		GFluxICtorFuncPtr_t	ctorptr,
		bool *	ptr )

Definition at line 93 of file GFluxDriverFactory.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 102 of file GFluxDriverFactory.h.

Member Data Documentation

fBoolPtrMap

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

private

Definition at line 74 of file GFluxDriverFactory.h.

Referenced by RegisterCreator().

fFunctionMap

std::map<std::string, GFluxICtorFuncPtr_t> genie::flux::GFluxDriverFactory::fFunctionMap

private

Definition at line 71 of file GFluxDriverFactory.h.

Referenced by AvailableFluxDrivers(), GetFluxDriver(), IsKnownFluxDriver(), and RegisterCreator().

fgTheInstance

GFluxDriverFactory * genie::flux::GFluxDriverFactory::fgTheInstance

staticprivate

Definition at line 68 of file GFluxDriverFactory.h.

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

listnames

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

mutableprivate

Definition at line 76 of file GFluxDriverFactory.h.

Referenced by AvailableFluxDrivers().

---

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

• GFluxDriverFactory.h
• GFluxDriverFactory.cxx