JAANET::JConstantFlux Struct Reference

Function object for constant fluxes. More...

#include <JConstantFlux.hh>

Inheritance diagram for JAANET::JConstantFlux:

Public Types
typedef JEvtWeightFactorConstant< JFlux >	JEvtWeightFactorConstant_t
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JConstantFlux ()
	Default constructor.
	JConstantFlux (const double flux)
	Constructor.
bool	is_valid () const override final
	Check whether this constant event-weight factor is valid.
double	getFactor (const Evt &evt) const override final
	Get event-weight factor of given event.
bool	less (const JEvtWeightFactorConstant_t &object) const
	Check if this event-weight constant is less than given event-weight constant.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) override final
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const override final
	Get properties of this class.
std::istream &	read (std::istream &in) override final
	Stream input.
std::ostream &	write (std::ostream &out) const override final
	Write event-weight factor to output.
virtual clone_type	clone () const override
	Get clone of this object.

Private Attributes
double	constant
	constant value

Detailed Description

Function object for constant fluxes.

Definition at line 21 of file JConstantFlux.hh.

Member Typedef Documentation

JEvtWeightFactorConstant_t

JEvtWeightFactorConstant<JFlux> JAANET::JEvtWeightFactorConstant< JFlux >::JEvtWeightFactorConstant_t

inherited

Definition at line 38 of file JEvtWeightFactorConstant.hh.

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

JConstantFlux() [1/2]

JAANET::JConstantFlux::JConstantFlux ( )

inline

Default constructor.

Definition at line 27 of file JConstantFlux.hh.

                    :
      JEvtWeightFactorConstant()
    {}

JConstantFlux() [2/2]

JAANET::JConstantFlux::JConstantFlux ( const double flux )

inline

Constructor.

Parameters

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

Definition at line 37 of file JConstantFlux.hh.

                                     :
      JEvtWeightFactorConstant(flux)
    {}

Member Function Documentation

is_valid()

bool JAANET::JEvtWeightFactorConstant< JFlux >::is_valid ( ) const

inlinefinaloverrideinherited

Check whether this constant event-weight factor is valid.

Returns

true if valid; else false

Definition at line 66 of file JEvtWeightFactorConstant.hh.

    {
      return constant > 0.0;
    }

getFactor()

double JAANET::JEvtWeightFactorConstant< JFlux >::getFactor ( const Evt & evt ) const

inlinefinaloverrideinherited

Get event-weight factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 78 of file JEvtWeightFactorConstant.hh.

    {
      return constant;
    }

less()

bool JAANET::JEvtWeightFactorConstant< JFlux >::less ( const JEvtWeightFactorConstant_t & object ) const

inlineinherited

Check if this event-weight constant is less than given event-weight constant.

Parameters

object

event-weight constant

Returns

true if this event-weight constant is less than given event-weight constant; else false

Definition at line 90 of file JEvtWeightFactorConstant.hh.

    {
      return this->constant < object.constant;
    }

getProperties() [1/2]

JProperties JAANET::JEvtWeightFactorConstant< JFlux >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlinefinaloverrideinherited

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 101 of file JEvtWeightFactorConstant.hh.

    {
      return JEvtWeightFactorConstantHelper(*this, eqpars);
    }

getProperties() [2/2]

JProperties JAANET::JEvtWeightFactorConstant< JFlux >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlinefinaloverrideinherited

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 112 of file JEvtWeightFactorConstant.hh.

    {
      return JEvtWeightFactorConstantHelper(*this, eqpars);      
    }

read()

std::istream & JAANET::JEvtWeightFactorConstant< JFlux >::read ( std::istream & in )

inlinefinaloverrideinherited

Stream input.

Parameters

in	input stream

Returns

input stream

Definition at line 124 of file JEvtWeightFactorConstant.hh.

    {
      using namespace std;
 
      streampos pos = in.tellg();      
      
      if (!(in >> constant)) {
 
        in.clear();
        in.seekg(pos);
 
        JProperties properties = getProperties();
 
        in >> properties;
      }
 
      this->check_validity();
 
      return in;
    }

write()

std::ostream & JAANET::JEvtWeightFactorConstant< JFlux >::write ( std::ostream & out ) const

inlinefinaloverrideinherited

Write event-weight factor to output.

Parameters

out	output stream

Returns

output stream

Definition at line 152 of file JEvtWeightFactorConstant.hh.

    {
      using namespace JPP;
      
      return out << FIXED(10,3) << constant;
    }

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));
    }

Member Data Documentation

constant

double JAANET::JEvtWeightFactorConstant< JFlux >::constant

privateinherited

constant value

Definition at line 186 of file JEvtWeightFactorConstant.hh.

---

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

• JConstantFlux.hh