JAANET::JFluxHelper Struct Reference

Helper class for flux function. More...

#include <JFluxHelper.hh>

Inheritance diagram for JAANET::JFluxHelper:

Public Types
typedef JEvtWeightFactorHelper::pointer_type	pointer_type

Public Member Functions
	JFluxHelper ()
	Default constructor.
	JFluxHelper (const pointer_type &flux)
	Constructor.
	JFluxHelper (const JFlux &flux)
	Constructor.
JFlux &	getFlux () const
	Get reference to flux function.
double	getFlux (const Evt &evt) const
	Get flux of given event.
void	configure (const pointer_type &p)
	Configure event-weight factor.
void	configure (const JEvtWeightFactor &factor)
	Configure event-weight factor.
JEvtWeightFactor &	getFactor () const
	Get reference to event-weight factor.
double	getFactor (const Evt &evt) const
	Get weight-factor of given event.
bool	is_valid () const
	Check whether this event-weight factor is valid.
double	operator() (const Evt &evt) const
	Get weight-factor of given event.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
	Get properties of this class.

Detailed Description

Helper class for flux function.

Definition at line 23 of file JFluxHelper.hh.

Member Typedef Documentation

pointer_type

JEvtWeightFactorHelper::pointer_type JAANET::JFluxHelper::pointer_type

Definition at line 26 of file JFluxHelper.hh.

Constructor & Destructor Documentation

JFluxHelper() [1/3]

JAANET::JFluxHelper::JFluxHelper ( )

inline

Default constructor.

Definition at line 32 of file JFluxHelper.hh.

    {}

JFluxHelper() [2/3]

JAANET::JFluxHelper::JFluxHelper ( const pointer_type & flux )

inline

Constructor.

Parameters

flux	flux function

Definition at line 41 of file JFluxHelper.hh.

                                          :
      JEvtWeightFactorHelper(flux)
    {}

JFluxHelper() [3/3]

JAANET::JFluxHelper::JFluxHelper ( const JFlux & flux )

inline

Constructor.

Parameters

flux	flux function

Definition at line 51 of file JFluxHelper.hh.

    {
      configure(flux);
    }

Member Function Documentation

getFlux() [1/2]

JFlux & JAANET::JFluxHelper::getFlux ( ) const

inline

Get reference to flux function.

Returns

reference to flux function

Definition at line 62 of file JFluxHelper.hh.

    {
      using namespace JPP;
 
      JEvtWeightFactor& factor = this->getFactor();
 
      JFlux* p = dynamic_cast<JFlux*>(&factor);
 
      if (p != NULL) {
        return *p;
      } else {
        THROW(JNullPointerException, "JFluxHelper::getFlux(): Cannot convert event-weight factor to flux function.");
      }
    }

getFlux() [2/2]

double JAANET::JFluxHelper::getFlux ( const Evt & evt ) const

inline

Get flux of given event.

Parameters

evt

event

Returns

flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 84 of file JFluxHelper.hh.

    {
      return getFactor(evt);
    }

configure() [1/2]

void JAANET::JEvtWeightFactorHelper::configure ( const pointer_type & p )

inlineinherited

Configure event-weight factor.

Parameters

p	pointer to event-weight factor

Definition at line 68 of file JEvtWeightFactorHelper.hh.

    {
      static_cast<pointer_type&>(*this) = p;
    }

configure() [2/2]

void JAANET::JEvtWeightFactorHelper::configure ( const JEvtWeightFactor & factor )

inlineinherited

Configure event-weight factor.

Parameters

factor

event-weight factor

Definition at line 79 of file JEvtWeightFactorHelper.hh.

    {
      using namespace JPP;
      
      JEvtWeightFactor* p = dynamic_cast<JEvtWeightFactor*>(factor.clone());
 
      if (p != NULL) {
        this->reset(p);
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Could not retrieve event-weight factor interface.");
      }
    }

getFactor() [1/2]

JEvtWeightFactor & JAANET::JEvtWeightFactorHelper::getFactor ( ) const

inlineinherited

Get reference to event-weight factor.

Returns

reference to event-weight factor

Definition at line 98 of file JEvtWeightFactorHelper.hh.

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

getFactor() [2/2]

double JAANET::JEvtWeightFactorHelper::getFactor ( const Evt & evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 129 of file JEvtWeightFactorHelper.hh.

    {
      const JEvtWeightFactor& weightFactor = getFactor();
 
      return weightFactor.getFactor(evt);
    }

is_valid()

bool JAANET::JEvtWeightFactorHelper::is_valid ( ) const

inlineinherited

Check whether this event-weight factor is valid.

Returns

true if valid; else false

Definition at line 115 of file JEvtWeightFactorHelper.hh.

    {
      const JEvtWeightFactorHelper& helper = static_cast<const JEvtWeightFactorHelper&>(*this);
      
      return (helper && helper->is_valid());
    }

operator()()

double JAANET::JEvtWeightFactorHelper::operator() ( const Evt & evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 143 of file JEvtWeightFactorHelper.hh.

    {
      return getFactor(evt);
    }

getProperties() [1/2]

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

inlineinherited

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 154 of file JEvtWeightFactorHelper.hh.

    {
      return getFactor().getProperties(eqpars);
    }

getProperties() [2/2]

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

inlineinherited

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 165 of file JEvtWeightFactorHelper.hh.

    {
      return getFactor().getProperties(eqpars);
    }

---

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

• JFluxHelper.hh