JAANET::JEvtWeightInterface Struct Reference

Low-level interface for event weighing. More...

#include <JEvtWeightInterface.hh>

Inheritance diagram for JAANET::JEvtWeightInterface:

Public Member Functions
virtual const char *const	getName () const =0
	Get name.
virtual void	configure (const JHead &header)=0
	Configuration.
virtual bool	check (const JHead &header) const =0
	Check whether header is consistent with this event weighter.
virtual double	getWeight (const Evt &evt) const =0
	Get weight of given event.
virtual double	getNormalisation () const =0
	Get event-weight normalisation factor.
virtual void	setNormalisation (const double normalisation)=0
	Set event-weight normalisation factor.

Detailed Description

Low-level interface for event weighing.

Definition at line 22 of file JEvtWeightInterface.hh.

Member Function Documentation

getName()

virtual const char *const JAANET::JEvtWeightInterface::getName ( ) const

pure virtual

Get name.

Returns

name

configure()

virtual void JAANET::JEvtWeightInterface::configure ( const JHead & header )

pure virtual

Configuration.

Parameters

header

header

check()

virtual bool JAANET::JEvtWeightInterface::check ( const JHead & header ) const

pure virtual

Check whether header is consistent with this event weighter.

Parameters

header

header

Returns

true if consistent; else false

getWeight()

virtual double JAANET::JEvtWeightInterface::getWeight ( const Evt & evt ) const

pure virtual

Get weight of given event.

Parameters

evt

event

Returns

weight [Hz]

getNormalisation()

virtual double JAANET::JEvtWeightInterface::getNormalisation ( ) const

pure virtual

Get event-weight normalisation factor.

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

Returns

event-weight normalisation factor.

Implemented in JAANET::JEvtWeight.

setNormalisation()

virtual void JAANET::JEvtWeightInterface::setNormalisation ( const double normalisation )

pure virtual

Set event-weight normalisation factor.

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

Parameters

normalisation

event-weight normalisation factor.

Implemented in JAANET::JEvtWeight.

---

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

• JEvtWeightInterface.hh