Jpp  master_rocky-43-ge265d140c
the software that should make you happy
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
JAANET::JEvtWeightFactor Struct Referenceabstract

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

#include <JEvtWeightFactor.hh>

Inheritance diagram for JAANET::JEvtWeightFactor:
JLANG::JClonable< JClonable_t, JDerived_t > JAANET::JEvtWeightFactorTFormula JAANET::JFlux JAANET::JDiffuseFlux

Public Types

typedef JClonable< JClonable_t >::clone_type clone_type
 

Public Member Functions

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

Static Public Member Functions

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

Friends

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

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

37  {}

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.

46  {
47  return "type";
48  }

◆ getFactor()

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

Get event-weight factor of given event.

Parameters
evtevent
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
evtevent
Returns
event-weight factor

Definition at line 66 of file JEvtWeightFactor.hh.

67  {
68  return getFactor(evt);
69  }
JAANET::JEvtWeightFactor::getFactor
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.

78  {
79  return true;
80  }

◆ check_validity()

void JAANET::JEvtWeightFactor::check_validity ( ) const
inline

Check validity of this event-weight factor.

Definition at line 86 of file JEvtWeightFactor.hh.

87  {
88  using namespace JPP;
89 
90  if (!is_valid()) {
91  THROW(JValueOutOfRange, "JEvtWeightFactor():check_validity(): Invalid event-weight factor " << *this);
92  }
93  }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JLANG::JValueOutOfRange
Exception for accessing a value in a collection that is outside of its range.
Definition: JException.hh:180
JPP
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition: JAAnetToolkit.hh:43
JAANET::JEvtWeightFactor::is_valid
virtual bool is_valid() const
Check whether this event-weight factor is valid.
Definition: JEvtWeightFactor.hh:77

◆ getEquationParameters()

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

Get equation parameters.

Returns
equation parameters

Definition at line 101 of file JEvtWeightFactor.hh.

102  {
103  static JEquationParameters equation("=", ",", "./", "#");
104 
105  return equation;
106  }
JLANG::JEquationParameters
Simple data structure to support I/O of equations (see class JLANG::JEquation).
Definition: JEquationParameters.hh:20

◆ setEquationParameters()

static void JAANET::JEvtWeightFactor::setEquationParameters ( const JEquationParameters &  eqpars)
inlinestatic

Set equation parameters.

Parameters
eqparsequation parameters

Definition at line 114 of file JEvtWeightFactor.hh.

115  {
116  getEquationParameters() = eqpars;
117  }
JAANET::JEvtWeightFactor::getEquationParameters
static JEquationParameters & getEquationParameters()
Get equation parameters.
Definition: JEvtWeightFactor.hh:101

◆ getProperties() [1/2]

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

Get properties of this class.

Parameters
eqparsequation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 125 of file JEvtWeightFactor.hh.

126  {
127  return JProperties(eqpars,1);
128  }
JEEP::JProperties
Utility class to parse parameter values.
Definition: JProperties.hh:501

◆ getProperties() [2/2]

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

Get properties of this class.

Parameters
eqparsequation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 136 of file JEvtWeightFactor.hh.

137  {
138  return JProperties(eqpars,1);
139  }

◆ read()

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

Read event-weight factor from input.

Parameters
ininput stream
Returns
input stream

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 148 of file JEvtWeightFactor.hh.

149  {
150  using namespace std;
151  using namespace JPP;
152 
153  JStringStream is(in);
154 
155  if (getFileStatus(is.str().c_str())) {
156  is.load();
157  }
158 
159  JProperties properties = getProperties();
160  is >> properties;
161 
162  check_validity();
163 
164  return in;
165  }
JLANG::JStringStream
Wrapper class around STL stringstream class to facilitate optional loading of data from file.
Definition: JStringStream.hh:25
JSYSTEM::getFileStatus
static JStat getFileStatus
Function object for file status.
Definition: JStat.hh:173
std
Definition: JSTDTypes.hh:14
JAANET::JEvtWeightFactor::getProperties
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
Get properties of this class.
Definition: JEvtWeightFactor.hh:125
JAANET::JEvtWeightFactor::check_validity
void check_validity() const
Check validity of this event-weight factor.
Definition: JEvtWeightFactor.hh:86

◆ write()

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

Write event-weight factor to output.

Parameters
outoutput stream
Returns
output stream

Definition at line 174 of file JEvtWeightFactor.hh.

175  {
176  return out << getProperties();
177  }

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

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

Friends And Related Function Documentation

◆ operator>>

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

Read event category from input.

Parameters
ininput stream
objectevent category
Returns
input stream

Definition at line 187 of file JEvtWeightFactor.hh.

188  {
189  return object.read(in);
190  }

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const JEvtWeightFactor &  object 
)
friend

Write event category to output.

Parameters
outoutput stream
objectevent category
Returns
output stream

Definition at line 200 of file JEvtWeightFactor.hh.

201  {
202  return object.write(out);
203  }
The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.1