JAANET::JEvtWeightFactor Struct Reference

Abstract base class for specifiable event-weight factors. More...

#include <JEvtWeightFactor.hh>

Inheritance diagram for JAANET::JEvtWeightFactor:

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
virtual	~JEvtWeightFactor ()
	Virtual destructor.
virtual double	getFactor (const Evt &evt) const =0
	Get event-weight factor of given event.
double	operator() (const Evt &evt) const
	Get event-weight factor of given event.
virtual bool	is_valid () const
	Check whether this event-weight factor is valid.
void	check_validity () const
	Check validity of this event-weight factor.
virtual JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
	Get properties of this class.
virtual JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
	Get properties of this class.
virtual std::istream &	read (std::istream &in)
	Read event-weight factor from input.
virtual std::ostream &	write (std::ostream &out) const
	Write event-weight factor to output.
virtual clone_type	clone () const override
	Get clone of this object.

Static Public Member Functions
static const char *const	getTypeKey ()
	Get type keyword.
static JEquationParameters &	getEquationParameters ()
	Get equation parameters.
static void	setEquationParameters (const JEquationParameters &eqpars)
	Set equation parameters.

Friends
std::istream &	operator>> (std::istream &in, JEvtWeightFactor &object)
	Read event category from input.
std::ostream &	operator<< (std::ostream &out, const JEvtWeightFactor &object)
	Write event category to output.

Detailed Description

Abstract base class for specifiable event-weight factors.

Definition at line 30 of file JEvtWeightFactor.hh.

Member Typedef Documentation

clone_type

template<class JClonable_t , class JDerived_t >

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

~JEvtWeightFactor()

virtual JAANET::JEvtWeightFactor::~JEvtWeightFactor ( )

inlinevirtual

Virtual destructor.

Definition at line 36 of file JEvtWeightFactor.hh.

    {}

Member Function Documentation

getTypeKey()

static const char *const JAANET::JEvtWeightFactor::getTypeKey ( )

inlinestatic

Get type keyword.

Returns

type keyword

Definition at line 45 of file JEvtWeightFactor.hh.

    {
      return "type";
    }

getFactor()

virtual double JAANET::JEvtWeightFactor::getFactor ( const Evt & evt ) const

pure virtual

Get event-weight factor of given event.

Parameters

evt

event

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

evt

event

Returns

event-weight factor

Definition at line 66 of file JEvtWeightFactor.hh.

    {
      return getFactor(evt);
    }

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.

    {
      return true;
    }

check_validity()

void JAANET::JEvtWeightFactor::check_validity ( ) const

inline

Check validity of this event-weight factor.

Definition at line 86 of file JEvtWeightFactor.hh.

    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JEvtWeightFactor():check_validity(): Invalid event-weight factor " << *this);
      }
    }

getEquationParameters()

static JEquationParameters & JAANET::JEvtWeightFactor::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns

equation parameters

Definition at line 101 of file JEvtWeightFactor.hh.

    {
      static JEquationParameters equation("=", ",", "./", "#");
       
      return equation;
    }    

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.

    {
      getEquationParameters() = eqpars;
    }

getProperties() [1/2]

virtual JProperties JAANET::JEvtWeightFactor::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlinevirtual

Get properties of this class.

Parameters

eqpars

equation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 125 of file JEvtWeightFactor.hh.

    {
      return JProperties(eqpars,1);
    }

getProperties() [2/2]

virtual JProperties JAANET::JEvtWeightFactor::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlinevirtual

Get properties of this class.

Parameters

eqpars

equation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 136 of file JEvtWeightFactor.hh.

    {
      return JProperties(eqpars,1);
    }

read()

virtual std::istream & JAANET::JEvtWeightFactor::read ( std::istream & in )

inlinevirtual

Read event-weight factor from input.

Parameters

in	input stream

Returns

input stream

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 148 of file JEvtWeightFactor.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
 
      JProperties properties = getProperties();
      is >> properties;
 
      check_validity();
 
      return in;      
    }

write()

virtual std::ostream & JAANET::JEvtWeightFactor::write ( std::ostream & out ) const

inlinevirtual

Write event-weight factor to output.

Parameters

out	output stream

Returns

output stream

Definition at line 174 of file JEvtWeightFactor.hh.

    {
      return out << getProperties();
    }

clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns

pointer to newly created object

Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JEvtWeightFactor & object )

friend

Read event category from input.

Parameters

in	input stream
object	event category

Returns

input stream

Definition at line 187 of file JEvtWeightFactor.hh.

    {
      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.

    {
      return object.write(out);
    }

---

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

• JEvtWeightFactor.hh