Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JPHYSICS::JRadiationSource Class Reference

Implementation for calculation of inverse interaction length and shower energy. More...

#include <JRadiationSource.hh>

Inheritance diagram for JPHYSICS::JRadiationSource:
JPHYSICS::JRadiationInterface JLANG::JSharedPointer< JClass_t, JMemory_t > JPHYSICS::JRadiationSource_t JLANG::JSharedCounter JLANG::JStorage< JClass_t, JNew > JLANG::JPointer< JClass_t > JLANG::JNew< JClass_t > JLANG::JAbstractPointer< JClass_t > JLANG::JEquals< JAbstractPointer< JClass_t > >

Public Types

typedef JPointer< JClass_t > pointer_type
 
typedef JStorage< JClass_t, JMemory_t > storage_type
 
typedef JNew< JClass_t > memory_type
 

Public Member Functions

 JRadiationSource (const int id, const JSharedPointer< JRadiation > &radiation, const double density, const JRadiationSource_t source)
 Constructor.
 
virtual double getInverseInteractionLength (const double E) const override
 Get inverse interaction length.
 
virtual double getEnergyOfShower (const double E) const override
 Get energy of shower.
 
virtual double getThetaRMS (const double E, const double Es) const override
 Get RMS of scattering angle.
 
int getID () const
 Get radiation identifer.
 
const JSharedPointergetSharedPointer () const
 Get shared pointer.
 
JSharedPointergetSharedPointer ()
 Get shared pointer.
 
void setSharedPointer (const JSharedPointer &object)
 Set shared pointer.
 
virtual void reset () override
 Reset pointer.
 
void reset (const JPointer< T > &pointer)
 Reset pointer.
 
void reset (JClass_t *p)
 Reset pointer.
 
template<class T >
void set (const JPointer< T > &pointer)
 Set pointer.
 
void initialise ()
 Initialise counter.
 
void attach (const JSharedCounter &object)
 Attach this counter to given shared counter object.
 
bool detach ()
 Detach.
 
const int getCount ()
 Get count.
 
void recreate ()
 Recreate object in memory.
 
void create ()
 Create object in memory.
 
void create (const unsigned int size)
 Create array of objects in memory.
 
virtual JClass_t * get () const override
 Get pointer.
 
JClass_t *const & getReference () const
 Get rereference to internal pointer.
 
JClass_t *& getReference ()
 Get rereference to internal pointer.
 
virtual bool equals (const JAbstractPointer &object) const
 Equals.
 
bool is_valid () const
 Check validity of pointer.
 
JClass_t * operator-> () const
 Smart pointer operator.
 
 operator JClass_t * () const
 Type conversion operator.
 

Static Public Member Functions

static void release (JClass_t *p)
 Release memory.
 

Public Attributes

double(JRadiation::* sigma )(const double) const
 total cross section method
 
double(JRadiation::* eloss )(const double) const
 energy loss method
 
double(JRadiation::* theta )(const double, const double) const
 scattering angle method
 

Protected Member Functions

void set (const JSharedPointer &object)
 Set pointer.
 
virtual void set (JClass_t *p) override
 Set pointer.
 
void release ()
 Release memory.
 

Protected Attributes

const double rho
 
int * counter
 
JClass_t * __p
 pointer to object
 

Private Attributes

const int id
 

Detailed Description

Implementation for calculation of inverse interaction length and shower energy.

This class implements the JRadiationInterface interface.
N.B: This class owns the object pointed to using JLANG::JSharedPointer.

Definition at line 89 of file JRadiationSource.hh.

Member Typedef Documentation

◆ pointer_type

template<class JClass_t , template< class > class JMemory_t = JNew>
JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type
inherited

Definition at line 34 of file JSharedPointer.hh.

◆ storage_type

template<class JClass_t , template< class > class JMemory_t = JNew>
JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type
inherited

Definition at line 35 of file JSharedPointer.hh.

◆ memory_type

JNew<JClass_t> JLANG::JStorage< JClass_t, JNew >::memory_type
inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

◆ JRadiationSource()

JPHYSICS::JRadiationSource::JRadiationSource ( const int id,
const JSharedPointer< JRadiation > & radiation,
const double density,
const JRadiationSource_t source )
inline

Constructor.

Parameters
idradiation identifier
radiationpointer to valid JRadition object
densitymass density of radiation material [gr/cm³]
sourcepointers to member methods of JRadiation

Definition at line 103 of file JRadiationSource.hh.

106 :
108 JSharedPointer<JRadiation>(radiation),
109 JRadiationSource_t(source),
110 rho(density)
111 {}
JRadiationInterface(const int id)
Constructor.

Member Function Documentation

◆ getInverseInteractionLength()

virtual double JPHYSICS::JRadiationSource::getInverseInteractionLength ( const double E) const
inlineoverridevirtual

Get inverse interaction length.

Parameters
Emuon energy [GeV]
Returns
inverse interaction length [m^-1]

Implements JPHYSICS::JRadiationInterface.

Definition at line 120 of file JRadiationSource.hh.

121 {
122 return ((*this)->*sigma)(E) * rho * 1.0e6;
123 }
double(JRadiation::* sigma)(const double) const
total cross section method

◆ getEnergyOfShower()

virtual double JPHYSICS::JRadiationSource::getEnergyOfShower ( const double E) const
inlineoverridevirtual

Get energy of shower.

Parameters
Emuon energy [GeV]
Returns
shower energy [GeV]

Implements JPHYSICS::JRadiationInterface.

Definition at line 132 of file JRadiationSource.hh.

133 {
134 return ((*this)->*eloss)(E);
135 }
double(JRadiation::* eloss)(const double) const
energy loss method

◆ getThetaRMS()

virtual double JPHYSICS::JRadiationSource::getThetaRMS ( const double E,
const double Es ) const
inlineoverridevirtual

Get RMS of scattering angle.

Parameters
Emuon energy [GeV]
Esshower energy [GeV]
Returns
RMS scattering angle [rad]

Implements JPHYSICS::JRadiationInterface.

Definition at line 145 of file JRadiationSource.hh.

146 {
147 return ((*this)->*theta)(E, Es/E);
148 }
double(JRadiation::* theta)(const double, const double) const
scattering angle method

◆ getID()

int JPHYSICS::JRadiationInterface::getID ( ) const
inlineinherited

Get radiation identifer.

Returns
identifier

Definition at line 48 of file JRadiationSource.hh.

49 {
50 return id;
51 }

◆ getSharedPointer() [1/2]

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.

96 {
97 return static_cast<const JSharedPointer&>(*this);
98 }
JSharedPointer()
Default constructor.

◆ getSharedPointer() [2/2]

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.

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

◆ setSharedPointer()

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
objectshared pointer

Definition at line 117 of file JSharedPointer.hh.

118 {
119 if (this->get() != object.get()) {
120
121 this->reset();
122
123 if (object.is_valid()) {
124 this->set(object);
125 }
126 }
127 }
bool is_valid() const
Check validity of pointer.
virtual JClass_t * get() const override
Get pointer.
Definition JPointer.hh:64
virtual void reset() override
Reset pointer.
void set(const JSharedPointer &object)
Set pointer.

◆ reset() [1/3]

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, JNew >.

Definition at line 171 of file JSharedPointer.hh.

172 {
173 if (this->detach()) {
175 }
176
178 }
virtual void reset() override
Reset pointer.
Definition JPointer.hh:84
virtual void reset() override
Reset pointer.
Definition JStorage.hh:42

◆ reset() [2/3]

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

Reset pointer.

Parameters
pointerpointer to object

Definition at line 35 of file JPointer.hh.

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

◆ reset() [3/3]

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

Reset pointer.

Parameters
ppointer to object

Definition at line 94 of file JAbstractPointer.hh.

95 {
96 if (this->get() != p) {
97
98 this->reset();
99
100 if (p != NULL) {
101 this->set(p);
102 }
103 }
104 }
virtual void set(JClass_t *p)=0
Set pointer.
virtual JClass_t * get() const =0
Get pointer.
virtual void reset()=0
Reset pointer.

◆ set() [1/3]

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
objectshared pointer

Definition at line 188 of file JSharedPointer.hh.

189 {
190 pointer_type::set(object.get());
191
192 this->attach(object);
193 }
virtual void set(JClass_t *p) override
Set pointer.
Definition JPointer.hh:75
void attach(const JSharedCounter &object)
Attach this counter to given shared counter object.

◆ set() [2/3]

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
ppointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

203 {
205
206 this->initialise();
207 }
void initialise()
Initialise counter.

◆ set() [3/3]

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

Set pointer.

Parameters
pointerpointer to object

Definition at line 96 of file JPointer.hh.

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

◆ initialise()

void JLANG::JSharedCounter::initialise ( )
inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

34 {
35 detach();
36
37 counter = new int(1);
38 }

◆ attach()

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

Attach this counter to given shared counter object.

Parameters
objectshared counter

Definition at line 46 of file JSharedCounter.hh.

47 {
48 detach();
49
50 counter = object.counter;
51
52 if (counter != NULL) {
53 ++(*counter);
54 }
55 }

◆ detach()

bool JLANG::JSharedCounter::detach ( )
inlineinherited

Detach.

Returns
true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

64 {
65 if (counter != NULL) {
66
67 if (--(*counter) == 0) {
68
69 delete counter;
70
71 counter = NULL;
72
73 return true;
74 }
75
76 counter = NULL;
77 }
78
79 return false;
80 }

◆ getCount()

const int JLANG::JSharedCounter::getCount ( )
inlineinherited

Get count.

Returns
count

Definition at line 88 of file JSharedCounter.hh.

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

◆ recreate()

void JLANG::JStorage< JClass_t, JNew >::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.

58 {
59 if (!this->is_valid()) {
60 this->set(memory_type::create());
61 }
62 }
static JClass_t * create()
Create object in memory.
Definition JMemory.hh:30

◆ create() [1/2]

void JLANG::JStorage< JClass_t, JNew >::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.

70 {
72 }

◆ create() [2/2]

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

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters
sizenumber of elements

Definition at line 81 of file JStorage.hh.

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

◆ release() [1/2]

void JLANG::JStorage< JClass_t, JNew >::release ( )
inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

92 {
93 memory_type::release(this->get());
94 }
static void release(JClass_t *p)
Release memory.
Definition JMemory.hh:41

◆ release() [2/2]

template<class JClass_t >
static void JLANG::JNew< JClass_t >::release ( JClass_t * p)
inlinestaticinherited

Release memory.

Parameters
ppointer to data

Definition at line 41 of file JMemory.hh.

42 {
43 delete p;
44 }

◆ get()

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

◆ getReference() [1/2]

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.

120 {
121 return __p;
122 }

◆ getReference() [2/2]

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.

131 {
132 return __p;
133 }

◆ equals()

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
objectabstract pointer
Returns
true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

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

◆ is_valid()

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.

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

◆ operator->()

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.

113 {
114 if (!is_valid())
115 THROW(JNullPointerException, "JAbstractPointer::operator->()");
116 else
117 return this->get();
118 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.

◆ operator JClass_t *()

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.

127 {
128 return this->get();
129 }

Member Data Documentation

◆ rho

const double JPHYSICS::JRadiationSource::rho
protected

Definition at line 151 of file JRadiationSource.hh.

◆ id

const int JPHYSICS::JRadiationInterface::id
privateinherited

Definition at line 79 of file JRadiationSource.hh.

◆ counter

int* JLANG::JSharedCounter::counter
protectedinherited

Definition at line 94 of file JSharedCounter.hh.

◆ __p

template<class JClass_t >
JClass_t* JLANG::JPointer< JClass_t >::__p
protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

◆ sigma

double(JRadiation::* JPHYSICS::JRadiationSource_t::sigma) (const double) const
inherited

total cross section method

Definition at line 506 of file JRadiation.hh.

◆ eloss

double(JRadiation::* JPHYSICS::JRadiationSource_t::eloss) (const double) const
inherited

energy loss method

Definition at line 507 of file JRadiation.hh.

◆ theta

double(JRadiation::* JPHYSICS::JRadiationSource_t::theta) (const double, const double) const
inherited

scattering angle method

Definition at line 508 of file JRadiation.hh.


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