Description

Dummy, common type for all plugins in Darwin.

This includes observables and generic plugins.

#include <IPlugin.h>

Inheritance diagram for IPlugin:

Public Member Functions
	IPlugin ()=default

virtual	~IPlugin ()

void	SetPath (const std::filesystem::path &file) noexcept

virtual void	Load (Darwin::Tools::Flow &, Darwin::Tools::MetaInfo &, int=0, const boost::property_tree::ptree &={})

	IPlugin ()=default

virtual	~IPlugin ()

void	SetPath (const std::filesystem::path &file) noexcept

virtual void	Load (Darwin::Tools::Flow &, Darwin::Tools::MetaInfo &, int=0, const boost::property_tree::ptree &={})

Protected Member Functions
virtual int	GetParamsVeto () noexcept

virtual int	GetParamsVeto () noexcept

Protected Attributes
int	steering = none

bool	isMC = false

Private Attributes
std::filesystem::path	file

Constructor & Destructor Documentation

◆ IPlugin() [1/2]

IPlugin ( )

default

◆ ~IPlugin() [1/2]

virtual ~IPlugin ( )

inlinevirtual

     {
         using namespace std;
         if (steering & verbose)
             cout << "IPlugin: destroying plugin from " << file << endl;
     }

◆ IPlugin() [2/2]

IPlugin ( )

default

◆ ~IPlugin() [2/2]

virtual ~IPlugin ( )

inlinevirtual

     {
         using namespace std;
         if (steering & verbose)
             cout << "IPlugin: destroying plugin from " << file << endl;
     }

Member Function Documentation

◆ GetParamsVeto() [1/2]

virtual int GetParamsVeto ( )

inlineprotectedvirtualnoexcept

Plugin's forbidden modes.

See also: Darwin::Tools::Mode

Reimplemented in TreeFlattener, TreeFlattener, and SilentPlugin.

41 { return none; }

◆ GetParamsVeto() [2/2]

virtual int GetParamsVeto ( )

inlineprotectedvirtualnoexcept

Plugin's forbidden modes.

See also: Darwin::Tools::Mode

Reimplemented in TreeFlattener, TreeFlattener, and SilentPlugin.

41 { return none; }

◆ Load() [1/2]

virtual void Load	(	Darwin::Tools::Flow &	,
		Darwin::Tools::MetaInfo &	,
		int	= `0`,
		const boost::property_tree::ptree &	= `{}`
	)

virtual

Set steering.

Load branches and histograms in overloads.

Todo:

Handle reproducibility (fix #99)

Take variations as additional input? (might be needed for histograms)

◆ Load() [2/2]

void Load	(	Darwin::Tools::Flow &	,
		Darwin::Tools::MetaInfo &	metainfo,
		int	steering = `0`,
		const boost::property_tree::ptree &	= `{}`
	)

virtual

Set steering.

Load branches and histograms in overloads.

Todo:

Handle reproducibility (fix #99)

Take variations as additional input? (might be needed for histograms)

     {
     int params_veto = GetParamsVeto();
     if (params_veto & (verbose | config | plugin))
         BOOST_THROW_EXCEPTION( logic_error("Plugins may not veto -v, -c, nor -p") );
     if (params_veto & steering) {
         string what = "The following steering options are vetoed:";
         if (params_veto & split  ) what += " -k -j";
         if (params_veto & fill   ) what += " -f";
         if (params_veto & Friend ) what += " -F";
         if (params_veto & syst   ) what += " -s";
         BOOST_THROW_EXCEPTION( invalid_argument(what) );
     }
     this->steering = steering;
  
     isMC = metainfo.Get<bool>("flags", "isMC");
 }
 catch (boost::exception& e) {
     BOOST_THROW_EXCEPTION( DE::PluginException(file, e) );
 }

◆ SetPath() [1/2]

void SetPath ( const std::filesystem::path & file )

inlinenoexcept

Set location of plugin file.

55 { this->file = file; }

◆ SetPath() [2/2]

void SetPath ( const std::filesystem::path & file )

inlinenoexcept

Set location of plugin file.

55 { this->file = file; }

Member Data Documentation

◆ file

std::filesystem::path file

private

plugin file

◆ isMC

bool isMC = false

protected

◆ steering

int steering = none