Implementation of event weighing for MUPAGE data. More...

#include <JEvtWeightMupage.hh>

Inheritance diagram for JAANET::JEvtWeightMupage:

Public Types
typedef JClonable< JClonable_t > ::clone_type	clone_type

typedef JPointer< JClass_t >	pointer_type

typedef JStorage< JClass_t, JMemory_t >	storage_type

typedef JMemory_t< JClass_t >	memory_type

Public Member Functions
	JEvtWeightMupage ()
	Default Constructor. More...

	JEvtWeightMupage (const JHead &header)
	Constructor. More...

	JEvtWeightMupage (const JHead &header, const JEvtWeightFactor &factor)
	Constructor. More...

	JEvtWeightMupage (const JEvtWeightMupage &object)
	Copy constructor. More...

void	configure (const JHead &header) override
	Configuration. More...

bool	check (const JHead &header) const override
	Check whether header is consistent with this event weighter. More...

double	getWeight (const Evt &evt) const override
	Get weight of given event. More...

virtual clone_type	clone () const override
	Get clone of this object. More...

void	configure (const JEvtWeightFactor &factor)
	Configure event-weight factor. More...

double	getFactor (const Evt &evt) const
	Get weight-factor of given event. More...

const JSharedPointer &	getSharedPointer () const
	Get shared pointer. More...

JSharedPointer &	getSharedPointer ()
	Get shared pointer. More...

void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer. More...

virtual void	reset () override
	Reset pointer. More...

template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer. More...

void	reset (JClass_t *p)
	Reset pointer. More...

template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer. More...

void	initialise ()
	Initialise counter. More...

void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object. More...

bool	detach ()
	Detach. More...

const int	getCount ()
	Get count. More...

void	recreate ()
	Recreate object in memory. More...

void	create ()
	Create object in memory. More...

void	create (const unsigned int size)
	Create array of objects in memory. More...

virtual JClass_t *	get () const override
	Get pointer. More...

JClass_t *const &	getReference () const
	Get rereference to internal pointer. More...

JClass_t *&	getReference ()
	Get rereference to internal pointer. More...

virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...

bool	is_valid () const
	Check validity of pointer. More...

JClass_t *	operator-> () const
	Smart pointer operator. More...

	operator JClass_t * () const
	Type conversion operator. More...

Protected Member Functions
void	set (const JSharedPointer &object)
	Set pointer. More...

virtual void	set (JClass_t *p) override
	Set pointer. More...

void	release ()
	Release memory. More...

Protected Attributes
int *	counter

JClass_t *	__p
	pointer to object More...

Private Attributes
double	W

Detailed Description

Implementation of event weighing for MUPAGE data.

Definition at line 29 of file JEvtWeightMupage.hh.

Member Typedef Documentation

template<class JClonable_t, class JDerived_t = JNullType>

typedef JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type

inherited

Definition at line 34 of file JSharedPointer.hh.

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type

inherited

Definition at line 35 of file JSharedPointer.hh.

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JMemory_t<JClass_t> JLANG::JStorage< JClass_t, JMemory_t >::memory_type

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

JAANET::JEvtWeightMupage::JEvtWeightMupage ( )

inline

Default Constructor.

Definition at line 36 of file JEvtWeightMupage.hh.

                        :
       JEvtWeightFactorHelper(),
       W(0.0)
     {}

JAANET::JEvtWeightMupage::JEvtWeightMupage ( const JHead & header )

inline

Constructor.

Parameters

header header

Definition at line 47 of file JEvtWeightMupage.hh.

                                           :
       JEvtWeightFactorHelper()
     {
       configure(header);
     } 

JAANET::JEvtWeightMupage::JEvtWeightMupage	(	const JHead &	header,
		const JEvtWeightFactor &	factor
	)

inline

Constructor.

Parameters

header	header
factor	factor

Definition at line 60 of file JEvtWeightMupage.hh.

     {
       configure(header);
       JEvtWeightFactorHelper::configure(factor);
     } 

JAANET::JEvtWeightMupage::JEvtWeightMupage ( const JEvtWeightMupage & object )

inline

Copy constructor.

Parameters

object original object

Definition at line 73 of file JEvtWeightMupage.hh.

     {
       this->W = object.W;
 
       if (object.is_valid()) {
         JEvtWeightFactorHelper::configure(*(object.get()));
       }
     }

Member Function Documentation

void JAANET::JEvtWeightMupage::configure ( const JHead & header )

inlineoverride

Configuration.

Parameters

header header

Definition at line 88 of file JEvtWeightMupage.hh.

     {
       const double dt = (header.time_interval.t2 - header.time_interval.t1 > 0.0 ?
                          header.time_interval.t2 - header.time_interval.t1       :
                          header.livetime.numberOfSeconds);
       
       if (check(header) && dt > 0.0) {
 
         W = 1.0 / dt;
 
       } else {
         
         THROW(JValueOutOfRange, "JEvtWeightMupage::configure(): Provided header is inconsistent with MUPAGE.");
       }
     }

bool JAANET::JEvtWeightMupage::check ( const JHead & header ) const

inlineoverride

Check whether header is consistent with this event weighter.

Parameters

header header

Returns: true if consistent; else false

Definition at line 111 of file JEvtWeightMupage.hh.

     {
       return is_mupage(header);
     }

double JAANET::JEvtWeightMupage::getWeight ( const Evt & evt ) const

inlineoverride

Get weight of given event.

Parameters

evt event

Returns: weight [1/s]

Definition at line 123 of file JEvtWeightMupage.hh.

     {
       if (is_valid()) {
         
         return W * getFactor(evt);
         
       } else {
         
         return W;
       }
     }

template<class JClonable_t, class JDerived_t = JNullType>

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::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 >, JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer_t< JArgument_t >, JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, and JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >.

Definition at line 69 of file JClonable.hh.

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

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

inlineinherited

Configure event-weight factor.

Parameters

factor event-weight factor

Definition at line 61 of file JEvtWeightFactorHelper.hh.

     {
       JEvtWeightFactor_t* p = dynamic_cast<JEvtWeightFactor_t*>(factor.clone());
 
       if (p != NULL) {
         reset(p);
       } else {
         THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Invalid downcast to class derived from JEvtWeightFactor.");
       }
     }

double JAANET::JEvtWeightFactorHelper< JEvtWeightFactor >::getFactor ( const Evt & evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt event

Returns: event-weight factor

Definition at line 79 of file JEvtWeightFactorHelper.hh.

     {
       if (is_valid()) {
         return get()->getFactor(evt);
       } else {
         THROW(JNullPointerException, "JEvtWeightFactorHelper::getFactor(): Unspecified event-weighting factor.");
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

const JSharedPointer& JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 95 of file JSharedPointer.hh.

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

template<class JClass_t, template< class > class JMemory_t = JNew>

JSharedPointer& JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 106 of file JSharedPointer.hh.

     {
       return static_cast<JSharedPointer&>(*this);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::setSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineinherited

Set shared pointer.

Parameters

object shared pointer

Definition at line 117 of file JSharedPointer.hh.

     {
       if (this->get() != object.get()) {
 
         this->reset();
 
         if (object.is_valid()) {
           this->set(object);
         }
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JClass_t, JMemory_t >.

Definition at line 171 of file JSharedPointer.hh.

     {
       if (this->detach()) {
         storage_type::reset();
       }
 
       pointer_type::reset();
     }

template<class JClass_t>

template<class T >

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

     {
       this->reset(pointer.get());
     }

template<class JClass_t>

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

     {
       if (this->get() != p) {
 
         this->reset();
 
         if (p != NULL) {
           this->set(p);
         }
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineprotectedinherited

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters

object shared pointer

Definition at line 188 of file JSharedPointer.hh.

     {
       pointer_type::set(object.get());
 
       this->attach(object);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( JClass_t * p )

inlineoverrideprotectedvirtualinherited

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

     {
       pointer_type::set(p);
 
       this->initialise();
     }

template<class JClass_t>

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

     {
       this->set(pointer.get());
     }

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

     {
       detach();
 
       counter = new int(1);
     }

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object shared counter

Definition at line 46 of file JSharedCounter.hh.

     {
       detach();
 
       counter = object.counter;
 
       if (counter != NULL) {
         ++(*counter);
       }
     }

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns: true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

     {
       if (counter != NULL) {
 
         if (--(*counter) == 0) {
 
           delete counter;
 
           counter = NULL;
 
           return true;
         }
 
         counter = NULL;
       }
 
       return false;
     }

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns: count

Definition at line 88 of file JSharedCounter.hh.

     {
       return (counter != NULL ? *counter : 0);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

     {
       if (!this->is_valid()) {
         this->set(memory_type::create());
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

     {
       this->reset(memory_type::create());
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

     {
       this->reset(memory_type::create(size));
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

     { 
       memory_type::release(this->get());
     }

template<class JClass_t>

virtual JClass_t* JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< T >, and JLANG::JMultiPointer< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 64 of file JPointer.hh.

     {
       return this->__p;
     }

template<class JClass_t>

JClass_t* const& JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

     {
       return __p;
     }

template<class JClass_t>

JClass_t* & JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

     {
       return __p;
     }

template<class JClass_t>

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

     {
       return this->get() == object.get();
     }

template<class JClass_t>

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

     { 
       return this->get() != NULL; 
     }

template<class JClass_t>

JClass_t* JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

     { 
       if (!is_valid())
         throw JNullPointerException("JAbstractPointer::operator->()");
       else
         return this->get();
     }

template<class JClass_t>

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

     {
       return this->get();
     }

Member Data Documentation

double JAANET::JEvtWeightMupage::W

private

Definition at line 136 of file JEvtWeightMupage.hh.

int* JLANG::JSharedCounter::counter

protectedinherited

Definition at line 94 of file JSharedCounter.hh.

template<class JClass_t>

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

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

JEvtWeightMupage.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation