JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t > Struct Template Reference

Helper class for event-weight factor. More...

#include <JEvtWeightFactorHelper.hh>

Inheritance diagram for JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >:

Public Types
typedef JEvtWeightFactorHelper < JEvtWeightFactor_t >	JEvtWeightFactorHelper_t
typedef std::shared_ptr < JEvtWeightFactor_t >	pointer_type

Public Member Functions
	JEvtWeightFactorHelper ()
	Default constructor. More...
	JEvtWeightFactorHelper (const JEvtWeightFactor_t &factor)
	Constructor. More...
void	configure (const JEvtWeightFactor_t &factor)
	Configure event-weight factor. More...
JEvtWeightFactor_t &	getEvtWeightFactor () const
	Get reference to event-weight factor. More...
double	getFactor (const Evt &evt) const
	Get weight-factor of given event. More...

Detailed Description

template<class JEvtWeightFactor_t>
struct JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >

Helper class for event-weight factor.

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

Definition at line 29 of file JEvtWeightFactorHelper.hh.

Member Typedef Documentation

template<class JEvtWeightFactor_t>

typedef JEvtWeightFactorHelper<JEvtWeightFactor_t> JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::JEvtWeightFactorHelper_t

Definition at line 32 of file JEvtWeightFactorHelper.hh.

template<class JEvtWeightFactor_t>

typedef std::shared_ptr<JEvtWeightFactor_t> JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::pointer_type

Definition at line 33 of file JEvtWeightFactorHelper.hh.

Constructor & Destructor Documentation

template<class JEvtWeightFactor_t>

JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::JEvtWeightFactorHelper ( )

inline

Default constructor.

Definition at line 39 of file JEvtWeightFactorHelper.hh.

    {}

template<class JEvtWeightFactor_t>

JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::JEvtWeightFactorHelper ( const JEvtWeightFactor_t &  factor )

inline

Constructor.

Parameters

factor

event-weight factor

Definition at line 48 of file JEvtWeightFactorHelper.hh.

    {
      configure(factor);
    }

Member Function Documentation

template<class JEvtWeightFactor_t>

void JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::configure ( const JEvtWeightFactor_t &  factor )

inline

Configure event-weight factor.

Parameters

factor

event-weight factor

Definition at line 59 of file JEvtWeightFactorHelper.hh.

    {
      using namespace JPP;
      
      JEvtWeightFactor_t* p = dynamic_cast<JEvtWeightFactor_t*>(factor.clone());

      if (p != NULL) {
        this->reset(p);
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Invalid downcast to class derived from JEvtWeightFactor.");
      }
    }

template<class JEvtWeightFactor_t>

JEvtWeightFactor_t& JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::getEvtWeightFactor ( ) const

inline

Get reference to event-weight factor.

Returns

reference to event-weight factor

Definition at line 78 of file JEvtWeightFactorHelper.hh.

    {
      using namespace JPP;

      if (static_cast<const JEvtWeightFactorHelper_t&>(*this)) {
        return *(this->get());
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::getEvtWeightFactor(): Event-weight factor is not set.");
      }
    }

template<class JEvtWeightFactor_t>

double JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::getFactor ( const Evt &  evt ) const

inline

Get weight-factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 96 of file JEvtWeightFactorHelper.hh.

    {
      const JEvtWeightFactor_t& weightFactor = getEvtWeightFactor();

      return weightFactor.getFactor(evt);
    }

---

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

• JEvtWeightFactorHelper.hh