gen::FortranInstance Class Reference

#include <FortranInstance.h>

Inheritance diagram for gen::FortranInstance:

Classes
struct	InstanceWrapper

Public Member Functions
void	call (void(&fn)())
template<typename T >
T	call (T(&fn)())
template<typename A >
void	call (void(&fn)(A), A a)
template<typename T , typename A >
T	call (T(&fn)(A), A a)
template<typename A1 , typename A2 >
void	call (void(&fn)(A1, A2), A1 a1, A2 a2)
template<typename T , typename A1 , typename A2 >
T	call (T(&fn)(A1, A2), A1 a1, A2 a2)
virtual void	enter ()
	FortranInstance ()
virtual void	leave ()
virtual void	upEvnt ()
virtual void	upInit ()
virtual bool	upVeto ()
virtual	~FortranInstance () noexcept(false)

Static Public Member Functions
template<typename T >
static T *	getInstance ()

Static Public Attributes
static const std::string	kFortranInstance = "FortranInstance"

Static Private Member Functions
static void	throwMissingInstance ()

Private Attributes
int	instanceNesting

Static Private Attributes
static FortranInstance *	currentInstance = 0

Friends
void	gen::upevnt_ ()
void	gen::upinit_ ()
void	gen::upveto_ (int *)

Detailed Description

Definition at line 15 of file FortranInstance.h.

Constructor & Destructor Documentation

gen::FortranInstance::FortranInstance ( )

inline

Definition at line 17 of file FortranInstance.h.

References noexcept, and ~FortranInstance().

: instanceNesting(0) {}

gen::FortranInstance::~FortranInstance ( )

virtualnoexcept

Definition at line 31 of file FortranInstance.cc.

References currentInstance, and edm::friendlyname::friendlyName().

Referenced by FortranInstance().

                                                     {
  if (currentInstance == this) {
    edm::LogWarning("ReentrancyProblem") << edm::friendlyname::friendlyName(typeid(*this).name())
                                         << " destroyed while it was the "
                                            "current active instance."
                                         << std::endl;
    currentInstance = nullptr;
  }
}

Member Function Documentation

void gen::FortranInstance::call ( void(&)()  fn )

inline

Definition at line 20 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

Referenced by gen::PomwigHadronizer::clear(), Herwig6Hadronizer::clear(), gen::Cascade2Hadronizer::imposeProperTime(), gen::Pythia6Hadronizer::imposeProperTime(), Herwig6Hadronizer::initialize(), gen::PomwigHadronizer::initializeForInternalPartons(), Herwig6Hadronizer::initializeForInternalPartons(), gen::PomwigHadronizer::readSettings(), and Herwig6Hadronizer::readSettings().

                            {
      InstanceWrapper wrapper(this);
      fn();
    }

template<typename T >

T gen::FortranInstance::call ( T(&)()  fn )

inline

Definition at line 25 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

                      {
      InstanceWrapper wrapper(this);
      return fn();
    }

template<typename A >

void gen::FortranInstance::call ( void(&)(A)  fn, A  a  )

inline

Definition at line 30 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

                                  {
      InstanceWrapper wrapper(this);
      fn(a);
    }

template<typename T , typename A >

T gen::FortranInstance::call ( T(&)(A)  fn, A  a  )

inline

Definition at line 35 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

                            {
      InstanceWrapper wrapper(this);
      return fn(a);
    }

template<typename A1 , typename A2 >

void gen::FortranInstance::call ( void(&)(A1, A2)  fn, A1  a1, A2  a2  )

inline

Definition at line 40 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

                                                {
      InstanceWrapper wrapper(this);
      fn(a1, a2);
    }

template<typename T , typename A1 , typename A2 >

T gen::FortranInstance::call ( T(&)(A1, A2)  fn, A1  a1, A2  a2  )

inline

Definition at line 45 of file FortranInstance.h.

References personalPlayback::fn, and wrapper.

                                          {
      InstanceWrapper wrapper(this);
      return fn(a1, a2);
    }

void gen::FortranInstance::enter ( )

virtual

Reimplemented in gen::Pythia6Service.

Definition at line 43 of file FortranInstance.cc.

References currentInstance, Exception, edm::friendlyname::friendlyName(), instanceNesting, and edm::errors::LogicError.

Referenced by gen::Pythia6Service::enter(), and gen::FortranInstance::InstanceWrapper::InstanceWrapper().

                               {
  // we should add a boost::mutex here if we care about being
  // multithread-safe
  if (currentInstance && currentInstance != this)
    throw edm::Exception(edm::errors::LogicError) << edm::friendlyname::friendlyName(typeid(*this).name())
                                                  << "::enter() called from a different "
                                                     "instance while an instance was already active."
                                                  << std::endl;

  if (!currentInstance && instanceNesting != 0)
    throw edm::Exception(edm::errors::LogicError) << edm::friendlyname::friendlyName(typeid(*this).name())
                                                  << "::enter() called on an empty "
                                                     "instance, but instance counter is nonzero."
                                                  << std::endl;

  currentInstance = this;
  instanceNesting++;
}

template<typename T >

static T* gen::FortranInstance::getInstance ( )

inlinestatic

Definition at line 76 of file FortranInstance.h.

References currentInstance, gen::FortranInstance::InstanceWrapper::instance, throwMissingInstance(), upEvnt(), upInit(), and upVeto().

                            {
      T *instance = dynamic_cast<T *>(currentInstance);
      if (!instance)
        throwMissingInstance();
      return instance;
    }

void gen::FortranInstance::leave ( )

virtual

Definition at line 62 of file FortranInstance.cc.

References currentInstance, Exception, edm::friendlyname::friendlyName(), instanceNesting, and edm::errors::LogicError.

Referenced by gen::FortranInstance::InstanceWrapper::~InstanceWrapper().

                               {
  if (!currentInstance)
    throw edm::Exception(edm::errors::LogicError) << edm::friendlyname::friendlyName(typeid(*this).name())
                                                  << "::leave() called without an "
                                                     "active instance."
                                                  << std::endl;
  else if (currentInstance != this)
    throw edm::Exception(edm::errors::LogicError) << edm::friendlyname::friendlyName(typeid(*this).name())
                                                  << "::leave() called from a "
                                                     "different instance."
                                                  << std::endl;
  else if (instanceNesting <= 0)
    throw edm::Exception(edm::errors::LogicError) << edm::friendlyname::friendlyName(typeid(*this).name())
                                                  << "::leave() called with a "
                                                     "nesting level of zero."
                                                  << std::endl;

  if (--instanceNesting == 0)
    currentInstance = nullptr;
}

void gen::FortranInstance::throwMissingInstance ( )

staticprivate

Definition at line 83 of file FortranInstance.cc.

References Exception, and edm::errors::LogicError.

Referenced by getInstance().

                                              {
  throw edm::Exception(edm::errors::LogicError) << "FortranInstance::getInstance() called from "
                                                   "a Fortran context, but no current instance "
                                                   "has been registered."
                                                << std::endl;
}

void gen::FortranInstance::upEvnt ( )

virtual

Reimplemented in Herwig6Hadronizer, gen::Pythia6ServiceWithCallback, and gen::Pythia6ServiceWithCallback.

Definition at line 100 of file FortranInstance.cc.

References Exception, and edm::friendlyname::friendlyName().

Referenced by getInstance().

                                {
  throw cms::Exception("UnimplementedCallback") << edm::friendlyname::friendlyName(typeid(*this).name())
                                                << "::upEvnt() stub called. "
                                                   "If user process needs to be generated, please derive "
                                                   "and implement the upEvnt() method."
                                                << std::endl;
}

void gen::FortranInstance::upInit ( )

virtual

Reimplemented in Herwig6Hadronizer, gen::Pythia6ServiceWithCallback, and gen::Pythia6ServiceWithCallback.

Definition at line 92 of file FortranInstance.cc.

References Exception, and edm::friendlyname::friendlyName().

Referenced by getInstance().

                                {
  throw cms::Exception("UnimplementedCallback") << edm::friendlyname::friendlyName(typeid(*this).name())
                                                << "::upInit() stub called. "
                                                   "If user process needs to be generated, please derive "
                                                   "and implement the upInit() method."
                                                << std::endl;
}

bool gen::FortranInstance::upVeto ( )

virtual

Reimplemented in gen::Pythia6ServiceWithCallback, and gen::Pythia6ServiceWithCallback.

Definition at line 108 of file FortranInstance.cc.

Referenced by getInstance().

{ return false; }

Friends And Related Function Documentation

void gen::upevnt_ ( )

friend

void gen::upinit_ ( )

friend

void gen::upveto_ ( int *  )

friend

Member Data Documentation

gen::FortranInstance * gen::FortranInstance::currentInstance = 0

staticprivate

Definition at line 107 of file FortranInstance.h.

Referenced by enter(), getInstance(), leave(), gen::upveto_(), and ~FortranInstance().

int gen::FortranInstance::instanceNesting

private

Definition at line 104 of file FortranInstance.h.

Referenced by enter(), and leave().

const std::string gen::FortranInstance::kFortranInstance = "FortranInstance"

static

Definition at line 88 of file FortranInstance.h.

Referenced by gen::call_pygive(), gen::ExternalDecayDriver::ExternalDecayDriver(), gen::Pythia6ServiceWithCallback::upVeto(), and gen::upveto_().