Abstract base class for specifiable event-weight factors.
More...
#include <JEvtWeightFactor.hh>
Abstract base class for specifiable event-weight factors.
Definition at line 30 of file JEvtWeightFactor.hh.
◆ clone_type
template<class JClonable_t , class JDerived_t >
◆ ~JEvtWeightFactor()
virtual JAANET::JEvtWeightFactor::~JEvtWeightFactor |
( |
| ) |
|
|
inlinevirtual |
◆ getTypeKey()
static const char* const JAANET::JEvtWeightFactor::getTypeKey |
( |
| ) |
|
|
inlinestatic |
◆ getFactor()
virtual double JAANET::JEvtWeightFactor::getFactor |
( |
const Evt & |
evt | ) |
const |
|
pure virtual |
Get event-weight factor of given event.
- Parameters
-
- Returns
- event-weight factor
Implemented in JAANET::JDiffuseFlux.
◆ operator()()
double JAANET::JEvtWeightFactor::operator() |
( |
const Evt & |
evt | ) |
const |
|
inline |
Get event-weight factor of given event.
- Parameters
-
- Returns
- event-weight factor
Definition at line 66 of file JEvtWeightFactor.hh.
virtual double getFactor(const Evt &evt) const =0
Get event-weight factor of given event.
◆ is_valid()
virtual bool JAANET::JEvtWeightFactor::is_valid |
( |
| ) |
const |
|
inlinevirtual |
Check whether this event-weight factor is valid.
- Returns
- true if valid; else false
Definition at line 77 of file JEvtWeightFactor.hh.
◆ check_validity()
void JAANET::JEvtWeightFactor::check_validity |
( |
| ) |
const |
|
inline |
Check validity of this event-weight factor.
Definition at line 86 of file JEvtWeightFactor.hh.
91 THROW(
JValueOutOfRange,
"JEvtWeightFactor():check_validity(): Invalid event-weight factor " << *
this);
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Exception for accessing a value in a collection that is outside of its range.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
virtual bool is_valid() const
Check whether this event-weight factor is valid.
◆ getEquationParameters()
Get equation parameters.
- Returns
- equation parameters
Definition at line 101 of file JEvtWeightFactor.hh.
Simple data structure to support I/O of equations (see class JLANG::JEquation).
◆ setEquationParameters()
static void JAANET::JEvtWeightFactor::setEquationParameters |
( |
const JEquationParameters & |
eqpars | ) |
|
|
inlinestatic |
Set equation parameters.
- Parameters
-
eqpars | equation parameters |
Definition at line 114 of file JEvtWeightFactor.hh.
static JEquationParameters & getEquationParameters()
Get equation parameters.
◆ getProperties() [1/2]
◆ getProperties() [2/2]
◆ read()
virtual std::istream& JAANET::JEvtWeightFactor::read |
( |
std::istream & |
in | ) |
|
|
inlinevirtual |
Read event-weight factor from input.
- Parameters
-
- Returns
- input stream
Reimplemented in JAANET::JEvtWeightFactorTFormula.
Definition at line 148 of file JEvtWeightFactor.hh.
Wrapper class around STL stringstream class to facilitate optional loading of data from file.
static JStat getFileStatus
Function object for file status.
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
Get properties of this class.
void check_validity() const
Check validity of this event-weight factor.
◆ write()
virtual std::ostream& JAANET::JEvtWeightFactor::write |
( |
std::ostream & |
out | ) |
const |
|
inlinevirtual |
Write event-weight factor to output.
- Parameters
-
- Returns
- output stream
Definition at line 174 of file JEvtWeightFactor.hh.
◆ clone()
template<class JClonable_t , class JDerived_t >
|
inlineoverridevirtualinherited |
Get clone of this object.
- Returns
- pointer to newly created object
Reimplemented in JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, and JPHYSICS::JPDFTransformer_t< JArgument_t >.
Definition at line 69 of file JClonable.hh.
71 return new JDerived_t(
static_cast<const JDerived_t&
>(*
this));
◆ operator>>
Read event category from input.
- Parameters
-
in | input stream |
object | event category |
- Returns
- input stream
Definition at line 187 of file JEvtWeightFactor.hh.
189 return object.read(in);
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
out, |
|
|
const JEvtWeightFactor & |
object |
|
) |
| |
|
friend |
Write event category to output.
- Parameters
-
out | output stream |
object | event category |
- Returns
- output stream
Definition at line 200 of file JEvtWeightFactor.hh.
202 return object.write(out);
The documentation for this struct was generated from the following file: