---

ISpectrum Class Reference

The virtual interface for Spectrum-type objects. More...

#include <ISpectrum.h>

Inheritance diagram for ISpectrum::

List of all members.

Public Methods
virtual const char *	particleName () const=0
	subclasses need to specify correct particle type. More...
virtual double	flux (double time) const=0
	calculate the flux, particles/m^2/sr. (default zero). More...
virtual double	solidAngle () const
	calcualte effective solid angle (default zero). More...
virtual std::string	title () const=0
	return a title describing the spectrum. More...
virtual double	interval (double time)=0
	a randomized interval to the next event - default is 1/rate(). More...
virtual double	energySrc (HepRandomEngine *engine, double time=0)=0
	interface for energy and direction (originally from Hirosima classes). More...
virtual std::pair< double, double >	dir (double energy, HepRandomEngine *engine)=0

---

Detailed Description

The virtual interface for Spectrum-type objects.

Class for holding function definitions of Spectrums... an abstract base class

Author:

Sean Robinson

$Header $

Definition at line 29 of file ISpectrum.h.

---

Member Function Documentation

virtual std::pair<double,double> ISpectrum::dir (  double    energy, HepRandomEngine *    engine )  [pure virtual]

Reimplemented in Spectrum, and TimeCandle. Referenced by FluxSource::computeLaunch().

virtual double ISpectrum::energySrc (  HepRandomEngine *    engine, double    time = 0 )  [pure virtual]

interface for energy and direction (originally from Hirosima classes). Reimplemented in Spectrum, and TimeCandle. Referenced by FluxSource::computeLaunch().

virtual double ISpectrum::flux (  double    time )  const [pure virtual]

calculate the flux, particles/m^2/sr. (default zero). Reimplemented in AlbedoPSpectrum, CHIMESpectrum, GalElSpectrum, HeSpectrum, Spectrum, and TimeDepSpectrum. Referenced by FluxSource::flux().

virtual double ISpectrum::interval (  double    time )  [pure virtual]

a randomized interval to the next event - default is 1/rate(). Reimplemented in Spectrum, and TimeCandle. Referenced by FluxSource::calculateInterval().

virtual const char* ISpectrum::particleName (    )  const [pure virtual]

subclasses need to specify correct particle type. Reimplemented in AlbedoPSpectrum, CHIMESpectrum, FILESpectrum, GalElSpectrum, HeSpectrum, SimpleSpectrum, Spectrum, TimeDepSpectrum, and TimeCandle.

virtual double ISpectrum::solidAngle (    )  const [inline, virtual]

calcualte effective solid angle (default zero). Reimplemented in AlbedoPSpectrum, CHIMESpectrum, GalElSpectrum, HeSpectrum, and Spectrum. Definition at line 41 of file ISpectrum.h. Referenced by FluxSource::setAcceptance(). {return 6.;}

virtual std::string ISpectrum::title (    )  const [pure virtual]

return a title describing the spectrum. Reimplemented in AlbedoPSpectrum, CHIMESpectrum, FILESpectrum, GalElSpectrum, HeSpectrum, SimpleSpectrum, Spectrum, TimeDepSpectrum, and TimeCandle. Referenced by FluxSource::displayTitle(), and FluxSource::title().

---

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

• ISpectrum.h

---