IFlux Class Reference

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

#include <IFlux.h>

List of all members.

Public Member Functions
	IFlux (std::string="")
	ctor, select the name
virtual	~IFlux ()
virtual std::string	name () const=0
	name of the flux
virtual std::string	title () const=0
	full title of the flux
virtual void	generate ()=0
	generate a new entry trajectory
virtual std::string	particleName () const=0
	the particle name of the last particle generated
virtual double	energy () const=0
	its kinetic energy
virtual Hep3Vector	launchPoint () const=0
	starting point
virtual Hep3Vector	launchDir () const=0
	direction
virtual double	time () const=0
	time (s) (absolute or elapsed??)
virtual double	rate () const=0
	return rate ( /mm**2 /s)
virtual void	setTargetArea (double area)=0
	set the area of the target
virtual double	targetArea () const=0
	get the target area
virtual std::string	findSource () const=0
	find which spectrum created the current particle
virtual int	numSource () const=0
	return a unique number correcponding to that spectrum
virtual void	pass (double t)=0
	pass a specific amount of time
virtual CLHEP::HepRotation	CELTransform (double time) const=0
	get the transformation matrix due to orientation of the Galaxy
virtual CLHEP::HepRotation	orientTransform (double time) const=0
	get the transformation matrix due to orientation of the spacecraft.
virtual void	addFactory (std::string name, const ISpectrumFactory *factory)=0
virtual double	gpsTime () const=0
virtual CLHEP::HepRotation	transformGlastToGalactic (double time) const=0
	this transforms glast-local (cartesian) vectors into galactic (cartesian) vectors
virtual EventSource *	currentEvent ()=0
virtual EventSource *	currentFlux ()=0
virtual void	writeSourceCharacteristic (std::ostream &out)=0
	write the characteristics of the current source distribution to a stream
virtual CLHEP::HepRotation	transformToGlast (double seconds, int index) const=0

---

Detailed Description

The virtual interface for Flux-type objects.

Author:

Toby Burnett tburnett@u.washington.edu

Abstract interface for an object that generates particles, Flux

Header

/nfs/slac/g/glast/ground/cvs/FluxSvc/FluxSvc/IFlux.h,v 1.32 2006/12/22 20:36:02 burnett Exp

Definition at line 26 of file IFlux.h.

---

Constructor & Destructor Documentation

IFlux::IFlux (  std::string  = ""  )  [inline]

ctor, select the name Definition at line 29 of file IFlux.h. {};

virtual IFlux::~IFlux (   )  [inline, virtual]

Definition at line 30 of file IFlux.h. {}

---

Member Function Documentation

virtual void IFlux::addFactory (  std::string  name, const ISpectrumFactory *  factory )  [pure virtual]

virtual CLHEP::HepRotation IFlux::CELTransform (  double  time  )  const [pure virtual]

get the transformation matrix due to orientation of the Galaxy

virtual EventSource* IFlux::currentEvent (   )  [pure virtual]

Referenced by FluxSvc::compositeSource().

virtual EventSource* IFlux::currentFlux (   )  [pure virtual]

virtual double IFlux::energy (   )  const [pure virtual]

its kinetic energy Referenced by FluxAlg::execute().

virtual std::string IFlux::findSource (   )  const [pure virtual]

find which spectrum created the current particle

virtual void IFlux::generate (   )  [pure virtual]

generate a new entry trajectory Referenced by FluxAlg::execute().

virtual double IFlux::gpsTime (   )  const [pure virtual]

virtual Hep3Vector IFlux::launchDir (   )  const [pure virtual]

direction Referenced by FluxAlg::execute().

virtual Hep3Vector IFlux::launchPoint (   )  const [pure virtual]

starting point Referenced by FluxAlg::execute().

virtual std::string IFlux::name (   )  const [pure virtual]

name of the flux Referenced by FluxAlg::execute(), and ExposureAlg::execute().

virtual int IFlux::numSource (   )  const [pure virtual]

return a unique number correcponding to that spectrum Referenced by FluxAlg::execute().

virtual CLHEP::HepRotation IFlux::orientTransform (  double  time  )  const [pure virtual]

get the transformation matrix due to orientation of the spacecraft.

virtual std::string IFlux::particleName (   )  const [pure virtual]

the particle name of the last particle generated Referenced by FluxAlg::execute().

virtual void IFlux::pass (  double  t  )  [pure virtual]

pass a specific amount of time

virtual double IFlux::rate (   )  const [pure virtual]

return rate ( /mm**2 /s) Referenced by FluxAlg::initialize().

virtual void IFlux::setTargetArea (  double  area  )  [pure virtual]

set the area of the target

virtual double IFlux::targetArea (   )  const [pure virtual]

get the target area Referenced by FluxAlg::initialize().

virtual double IFlux::time (   )  const [pure virtual]

time (s) (absolute or elapsed??) Referenced by FluxAlg::execute().

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

full title of the flux Referenced by FluxAlg::initialize().

virtual CLHEP::HepRotation IFlux::transformGlastToGalactic (  double  time  )  const [pure virtual]

this transforms glast-local (cartesian) vectors into galactic (cartesian) vectors

virtual CLHEP::HepRotation IFlux::transformToGlast (  double  seconds, int  index )  const [pure virtual]

virtual void IFlux::writeSourceCharacteristic (  std::ostream &  out  )  [pure virtual]

write the characteristics of the current source distribution to a stream

---

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

• IFlux.h

---