Jpp  17.3.0-rc.2
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
JAANET::JEvtWeight Struct Referenceabstract

Abstract base class for event weighing. More...

#include <JEvtWeight.hh>

Inheritance diagram for JAANET::JEvtWeight:
JAANET::JEvtWeightInterface JLANG::JClonable< JClonable_t, JDerived_t >

Public Types

typedef JClonable< JClonable_t >
::clone_type 
clone_type
 

Public Member Functions

 JEvtWeight ()
 Default constructor. More...
 
virtual ~JEvtWeight ()
 Virtual destructor. More...
 
virtual double getNormalisation () const override
 Get event-weight normalisation. More...
 
virtual void configure (const JHead &header)=0
 Configuration. More...
 
virtual bool check (const JHead &header) const =0
 Check whether header is consistent with this event weighter. More...
 
virtual double getWeight (const Evt &evt) const =0
 Get weight of given event. More...
 
virtual clone_type clone () const override
 Get clone of this object. More...
 

Protected Attributes

double norm
 Event-weight normalisation. More...
 

Detailed Description

Abstract base class for event weighing.

Definition at line 21 of file JEvtWeight.hh.

Member Typedef Documentation

template<class JClonable_t, class JDerived_t = JNullType>
typedef JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type
inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

JAANET::JEvtWeight::JEvtWeight ( )
inline

Default constructor.

Definition at line 28 of file JEvtWeight.hh.

28  : norm(0.0)
29  {}
double norm
Event-weight normalisation.
Definition: JEvtWeight.hh:53
virtual JAANET::JEvtWeight::~JEvtWeight ( )
inlinevirtual

Virtual destructor.

Definition at line 35 of file JEvtWeight.hh.

36  {}

Member Function Documentation

virtual double JAANET::JEvtWeight::getNormalisation ( ) const
inlineoverridevirtual

Get event-weight normalisation.

Note: the return-value should be multiplied in order to normalise the event-weight

Returns
event-weight normalisation

Implements JAANET::JEvtWeightInterface.

Definition at line 45 of file JEvtWeight.hh.

46  {
47  return norm;
48  }
double norm
Event-weight normalisation.
Definition: JEvtWeight.hh:53
virtual void JAANET::JEvtWeightInterface::configure ( const JHead header)
pure virtualinherited

Configuration.

Parameters
headerheader
virtual bool JAANET::JEvtWeightInterface::check ( const JHead header) const
pure virtualinherited

Check whether header is consistent with this event weighter.

Parameters
headerheader
Returns
true if consistent; else false
virtual double JAANET::JEvtWeightInterface::getWeight ( const Evt evt) const
pure virtualinherited

Get weight of given event.

Parameters
evtevent
Returns
weight [Hz]
template<class JClonable_t, class JDerived_t = JNullType>
virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const
inlineoverridevirtualinherited

Member Data Documentation

double JAANET::JEvtWeight::norm
protected

Event-weight normalisation.

Definition at line 53 of file JEvtWeight.hh.


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