JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t > Struct Template Reference

Auxiliary class for organising Monte Carlo file scanners associated with event weighters. More...

#include <JEvtWeightFileScannerSet.hh>

Inheritance diagram for JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >:

Public Types
typedef JEvtWeightFileScanner < JFileScanner_t >	value_type
typedef std::vector < value_type >::const_iterator	const_iterator
typedef std::vector < value_type >::iterator	iterator
typedef std::vector < value_type > ::const_reverse_iterator	const_reverse_iterator
typedef std::vector < value_type > ::reverse_iterator	reverse_iterator
typedef std::vector < value_type >::reference	reference
typedef std::vector < value_type > ::const_reference	const_reference

Public Member Functions
	JEvtWeightFileScannerSet ()
	Default constructor. More...
	JEvtWeightFileScannerSet (const JMultipleFileScanner_t &input)
	Constructor. More...
size_t	put (const JMultipleFileScanner_t &input)
	Put file. More...
bool	put (const std::string &input)
	Put file. More...
std::string	getUniqueIdentifier (const_iterator p) const
	Get unique identifier for a file-scanner contained within this set of event-weighter-associated file-scanners. More...
const JEvtWeightFileScanner < JFileScanner_t > &	find (const JHead &head) const
	Find file scanner compatible with a given header. More...
template<class JEvtWeightFactor_t = JEvtWeightFactor>
size_t	setEvtWeightFactor (const int type, const JEvtWeightFactor_t &factor)
	Set event-weighting factor for all MC-files corresponding to a given PDG code. More...
template<class JEvtWeightFactor_t = JEvtWeightFactor>
size_t	setEvtWeightFactor (const std::set< int > &types, const JEvtWeightFactor_t &factor)
	Set event-weight factor of all MC-files corresponding to a given set of PDG codes. More...
template<class JEvtWeightFactor_t = JEvtWeightFactor>
size_t	setEvtWeightFactor (const JEvtWeightFactorMultiParticle< JEvtWeightFactor_t > &multiParticleFactor)
	Set event-weight factor of all MC-files corresponding to a given multi-particle flux. More...
size_t	setFlux (const int type, const JFlux &flux)
	Set flux function for all MC-files corresponding to a given PDG code. More...
size_t	setFlux (const std::set< int > &types, const JFlux &flux)
	Set flux function of all MC-files corresponding to a given set of PDG codes. More...
size_t	setFlux (const JEvtWeightFactorMultiParticle< JFlux > &multiParticleFlux)
	Set flux function of all MC-files corresponding to a given multi-particle flux interface. More...

Public Attributes
JComparator_t	compare
	Function object for comparison of headers. More...

Detailed Description

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>
struct JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >

Auxiliary class for organising Monte Carlo file scanners associated with event weighters.

Definition at line 49 of file JEvtWeightFileScannerSet.hh.

Member Typedef Documentation

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef JEvtWeightFileScanner<JFileScanner_t> JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::value_type

Definition at line 52 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::const_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_iterator

Definition at line 54 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::iterator

Definition at line 55 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::const_reverse_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_reverse_iterator

Definition at line 56 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::reverse_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::reverse_iterator

Definition at line 57 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::reference JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::reference

Definition at line 59 of file JEvtWeightFileScannerSet.hh.

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

typedef std::vector<value_type>::const_reference JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_reference

Definition at line 60 of file JEvtWeightFileScannerSet.hh.

Constructor & Destructor Documentation

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::JEvtWeightFileScannerSet ( )

inline

Default constructor.

Definition at line 66 of file JEvtWeightFileScannerSet.hh.

    {}

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::JEvtWeightFileScannerSet ( const JMultipleFileScanner_t &  input )

inline

Constructor.

Parameters

input

file list

Definition at line 75 of file JEvtWeightFileScannerSet.hh.

    {
      put(input);
    }

Member Function Documentation

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::put ( const JMultipleFileScanner_t &  input )

inline

Put file.

Parameters

input

file list

Returns

number of added files

Definition at line 87 of file JEvtWeightFileScannerSet.hh.

    {
      size_t n = 0;
      
      for (JMultipleFileScanner_t::const_iterator i = input.begin(); i != input.end(); ++i) {
        n += size_t(this->put(*i));
      }

      return n;
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

bool JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::put ( const std::string &  input )

inline

Put file.

Parameters

input

file name

Returns

true if successfully added; else false.

Definition at line 105 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
      
      const JHead& head = getHeader(input);

      iterator i = lower_bound(this->begin(),  this->end(),  head,
                               make_comparator(&JHead::getHeader, compare));

      if (i == this->end() || !i->getHeader().match(head)) {
        i = this->insert(i, value_type(getEventWeighter(head)));
      }

      return i->put(input);
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::string JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::getUniqueIdentifier ( const_iterator  p ) const

inline

Get unique identifier for a file-scanner contained within this set of event-weighter-associated file-scanners.

Parameters

p	iterator to contained file-scanner

Returns

unique identifier of contained file-scanner

Definition at line 129 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;

      static const char SEPARATOR = '.';

      string name  = p->getProgramName();
      int    index = 0;
      
      for (typename vector<value_type>::const_iterator i = this->cbegin(); i != this->cend() && i != p; ++i) {
        if (i->getProgramName() == name) {
          ++index;
        }
      }
      
      return MAKE_STRING(name << SEPARATOR << index);
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

const JEvtWeightFileScanner<JFileScanner_t>& JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::find ( const JHead &  head ) const

inline

Find file scanner compatible with a given header.

Parameters

head

header

Returns

file scanner

Definition at line 155 of file JEvtWeightFileScannerSet.hh.

    {
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        if (i->match(head)) {
          return *i;
        }
      }

      THROW(JValueOutOfRange, "JEvtWeightFileScannerSet::get(): No corresponding scanner found for given header.");
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

template<class JEvtWeightFactor_t = JEvtWeightFactor>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor ( const int  type, const JEvtWeightFactor_t &  factor  )

inline

Set event-weighting factor for all MC-files corresponding to a given PDG code.

The template argument corresponds to the desired class of event-weight factor. This class must contain the method getFactor(const Evt&).

Note that the given event-weighting factor will only be assigned to those files
whose header exclusively lists the given PDG code as primary.

Parameters

type	PDG code
factor	event-weight factor

Returns

number of modified event weighters

Definition at line 181 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;

      size_t n = 0;
        
      for (iterator i = this->begin(); i != this->end(); ++i) {
        n += (size_t) i->template setEvtWeightFactor<JEvtWeightFactor_t>(type, factor);
      }

      return n;
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

template<class JEvtWeightFactor_t = JEvtWeightFactor>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor ( const std::set< int > &  types, const JEvtWeightFactor_t &  factor  )

inline

Set event-weight factor of all MC-files corresponding to a given set of PDG codes.

The template argument corresponds to the desired class of event-weight factor. This class must contain the method getFactor(const Evt&).

Note that the given event-weighting factor will only be assigned to those files
whose header lists < b>all< /b> of the specified PDG codes as primaries.

Parameters

types	set of PDG codes
factor	event-weight factor

Returns

number of modified event weighters

Definition at line 211 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;

      size_t n = 0;

      for (iterator i = this->begin(); i != this->end(); ++i) {
        n += (size_t) i->template setEvtWeightFactor<JEvtWeightFactor_t>(types, factor);
      }
      
      return n;
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

template<class JEvtWeightFactor_t = JEvtWeightFactor>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor ( const JEvtWeightFactorMultiParticle< JEvtWeightFactor_t > &  multiParticleFactor )

inline

Set event-weight factor of all MC-files corresponding to a given multi-particle flux.

The template argument corresponds to the desired class of event-weight factor. This class must contain the method getFactor(const Evt&).

Note that the given event-weighting factors will only be assigned to those files
whose header lists < b>all< /b> of the PDG codes associated with the multi-particle event-weighting factor object as primaries.

Parameters

multiParticleFactor

multi-particle event-weight factor

Returns

number of modified event weighters

Definition at line 240 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;

      size_t n = 0;
      
      for (iterator i = this->begin(); i != this->end(); ++i) {
        n += (size_t) i->template setEvtWeightFactor<JEvtWeightFactor_t>(multiParticleFactor);  
      }
      
      return n;
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux ( const int  type, const JFlux &  flux  )

inline

Set flux function for all MC-files corresponding to a given PDG code.

Note that only the given flux function will only be assigned to those files
whose header exclusively lists the given PDG code as primary.

Parameters

type	PDG code
flux	flux function

Returns

number of modified event weighters

Definition at line 265 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor<JFlux>(type, flux);
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux ( const std::set< int > &  types, const JFlux &  flux  )

inline

Set flux function of all MC-files corresponding to a given set of PDG codes.

Note that the given flux function will only be assigned to those files
whose header lists < b>all< /b> of the specified PDG codes as primaries.

Parameters

types	set of PDG codes
flux	flux function

Returns

number of modified event weighters

Definition at line 282 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor<JFlux>(types, flux);
    }

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux ( const JEvtWeightFactorMultiParticle< JFlux > &  multiParticleFlux )

inline

Set flux function of all MC-files corresponding to a given multi-particle flux interface.

Note that the given flux functions will only be assigned to those files
whose header lists < b>all< /b> of the PDG codes associated with the multi-particle flux interface as primaries.

Parameters

multiParticleFlux

multi-particle flux object

Returns

number of modified event weighters

Definition at line 298 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor<JFlux>(multiParticleFlux);
    }

Member Data Documentation

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JComparator_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::compare

Function object for comparison of headers.

Definition at line 307 of file JEvtWeightFileScannerSet.hh.

---

The documentation for this struct was generated from the following file:

• JEvtWeightFileScannerSet.hh