Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

IFlux Class Reference

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

#include <IFlux.h>

Inheritance diagram for IFlux::

Flux List of all members.

Public Methods

 IFlux (std::string name="")
 ctor, select the name. More...

virtual ~IFlux ()
virtual std::string name () const=0
 name of the flux. More...

virtual std::string title () const=0
 full title of the flux. More...

virtual void generate ()=0
 generate a new entry trajectory. More...

virtual std::string particleName () const=0
 the particle name of the last particle generated. More...

virtual double energy () const=0
 its kinetic energy. More...

virtual HepPoint3D launchPoint () const=0
 starting point. More...

virtual HepVector3D launchDir () const=0
 direction. More...

virtual double time () const=0
 time (s) (absolute or elapsed??). More...

virtual double rate () const=0
 return rate ( /mm**2 /s). More...

virtual void setTargetArea (double area)=0
 set the area of the target. More...

virtual double targetArea () const=0
 get the target area. More...

virtual std::string findSource () const=0
 find which spectrum created the current particle. More...

virtual int numSource () const=0
 return a unique number correcponding to that spectrum. More...

virtual void pass (double t)=0
 pass a specific amount of time. More...

virtual Rotation CELTransform (double time) const=0
 get the transformation matrix due to orientation of the Galaxy. More...

virtual Rotation orientTransform (double time) const=0
 get the transformation matrix due to orientation of the spacecraft. More...

virtual void addFactory (std::string name, const ISpectrumFactory *factory)=0
virtual double gpsTime () const=0
virtual Rotation transformGlastToGalactic (double time) const=0
 this transforms glast-local (cartesian) vectors into galactic (cartesian) vectors. More...

virtual EventSourcecurrentEvent ()=0
virtual FluxSourcecurrentFlux ()=0
virtual void writeSourceCharacteristic (std::ostream &out)=0
 write the characteristics of the current source distribution to a stream. More...


Detailed Description

The virtual interface for Flux-type objects.

Author:
Toby Burnett tburnett@u.washington.edu
$Header $

Definition at line 27 of file IFlux.h.


Constructor & Destructor Documentation

IFlux::IFlux std::string    name = "" [inline]
 

ctor, select the name.

Definition at line 30 of file IFlux.h.

References name().

00030 {};

virtual IFlux::~IFlux   [inline, virtual]
 

Definition at line 31 of file IFlux.h.

References name(), and time().

00031 {}


Member Function Documentation

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

Reimplemented in Flux.

virtual Rotation IFlux::CELTransform double    time const [pure virtual]
 

get the transformation matrix due to orientation of the Galaxy.

Reimplemented in Flux.

virtual EventSource* IFlux::currentEvent   [pure virtual]
 

Reimplemented in Flux.

virtual FluxSource* IFlux::currentFlux   [pure virtual]
 

Reimplemented in Flux.

virtual double IFlux::energy   const [pure virtual]
 

its kinetic energy.

Reimplemented in Flux.

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

find which spectrum created the current particle.

Reimplemented in Flux.

virtual void IFlux::generate   [pure virtual]
 

generate a new entry trajectory.

Reimplemented in Flux.

virtual double IFlux::gpsTime   const [pure virtual]
 

Reimplemented in Flux.

Referenced by FluxSvc::run().

virtual HepVector3D IFlux::launchDir   const [pure virtual]
 

direction.

Reimplemented in Flux.

virtual HepPoint3D IFlux::launchPoint   const [pure virtual]
 

starting point.

Reimplemented in Flux.

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

name of the flux.

Reimplemented in Flux.

Referenced by IFlux(), and ~IFlux().

virtual int IFlux::numSource   const [pure virtual]
 

return a unique number correcponding to that spectrum.

Reimplemented in Flux.

virtual Rotation IFlux::orientTransform double    time const [pure virtual]
 

get the transformation matrix due to orientation of the spacecraft.

Reimplemented in Flux.

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

the particle name of the last particle generated.

Reimplemented in Flux.

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

pass a specific amount of time.

Reimplemented in Flux.

virtual double IFlux::rate   const [pure virtual]
 

return rate ( /mm**2 /s).

Reimplemented in Flux.

Referenced by FluxTestAlg::initialize().

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

set the area of the target.

Reimplemented in Flux.

virtual double IFlux::targetArea   const [pure virtual]
 

get the target area.

Reimplemented in Flux.

Referenced by FluxTestAlg::initialize().

virtual double IFlux::time   const [pure virtual]
 

time (s) (absolute or elapsed??).

Reimplemented in Flux.

Referenced by FluxTestAlg::execute(), and ~IFlux().

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

full title of the flux.

Reimplemented in Flux.

Referenced by FluxTestAlg::initialize().

virtual Rotation IFlux::transformGlastToGalactic double    time const [pure virtual]
 

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

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

write the characteristics of the current source distribution to a stream.

Reimplemented in Flux.

Referenced by FluxTestAlg::finalize().


The documentation for this class was generated from the following file:
Generated on Wed Oct 16 14:01:34 2002 by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001