IFluxSvc Class Reference

The FluxSvc gaudi service interface. More...

#include <IFluxSvc.h>

Inheritance diagram for IFluxSvc:

[legend]List of all members.

Public Member Functions
virtual StatusCode	source (std::string name, IFlux *&)=0
	just get an IFlux object by name -- see compositeSource
virtual std::list< std::string >	fluxNames () const=0
	return a list of legal names
virtual void	addFactory (std::string name, const ISpectrumFactory *factory)=0
	add a new source
virtual CLHEP::HepRandomEngine *	getRandomEngine ()=0
	return pointer to the random engine that FluxSvc uses
virtual void	pass (double t)=0
	pass a specific amount of time
virtual void	rootDisplay (std::vector< std::string > arguments)=0
	create a set of display windows using rootplot.
virtual void	attachGpsObserver (Observer *anObserver)=0
	allow an external observer to attach to gps
virtual IFlux *	currentFlux ()=0
	return the pointer to the current IFlux object
virtual std::string	fluxName () const=0
	name of the flux
virtual void	setPointingDirection (const astro::SkyDir &dir)=0
	set the pointing direction
virtual CLHEP::HepRotation	transformGlastToGalactic (double time) const=0
	this transforms glast-local (cartesian) vectors into galactic (cartesian) vectors
virtual CLHEP::HepRotation	transformToGlast (double seconds, astro::GPS::CoordSystem index) const=0
virtual std::pair< double, double >	location ()=0
	get the current satellite location
virtual astro::GPS *	GPSinstance ()=0
	return pointer to the GPS instance of FluxSVc
virtual std::vector< double >	setRockType (astro::GPS::RockType rockType, double rockAngle)=0
	set the type of rocking, along with the angle to rock to.
virtual std::vector< std::pair< std::string,std::list< std::string > > >	sourceOriginList () const=0
	this should return the source file names, along with the contained sources.
virtual StatusCode	compositeSource (std::vector< std::string > names, IFlux *&flux)=0
	set pointer to a flux object, constructed from set of names
virtual bool	insideSAA ()=0
	return current SAA status
virtual void	setAlignmentRotation (double qx, double qy, double qz, bool misalign=false)=0
	set aligmnment for Glast.
virtual void	setSAABoundary (const std::vector< std::pair< double, double > > &boundary)=0
	set the SAA boundary
virtual double	endruntime ()=0
	access end of run time
virtual void	setFilterCone (std::vector< double > cone)=0
	set filter cone parameters (ra, dec, radius)
Static Public Member Functions
const InterfaceID &	interfaceID ()
	Retrieve interface ID.

---

Detailed Description

The FluxSvc gaudi service interface.

Author:

Toby Burnett tburnett@u.washington.edu

Header

/nfs/slac/g/glast/ground/cvs/FluxSvc/FluxSvc/IFluxSvc.h,v 1.54 2007/08/15 18:49:28 burnett Exp

Definition at line 37 of file IFluxSvc.h.

---

Member Function Documentation

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

add a new source Implemented in FluxSvc. Referenced by RemoteSpectrumFactory< T >::RemoteSpectrumFactory().

virtual void IFluxSvc::attachGpsObserver (  Observer *  anObserver  )  [pure virtual]

allow an external observer to attach to gps Implemented in FluxSvc. Referenced by FluxAlg::initialize(), and ExposureAlg::initialize().

virtual StatusCode IFluxSvc::compositeSource (  std::vector< std::string >  names, IFlux *&  flux )  [pure virtual]

set pointer to a flux object, constructed from set of names Implemented in FluxSvc. Referenced by FluxAlg::initialize().

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

return the pointer to the current IFlux object Implemented in FluxSvc. Referenced by FluxAlg::execute(), and ExposureAlg::execute().

virtual double IFluxSvc::endruntime (   )  [pure virtual]

access end of run time Implemented in FluxSvc. Referenced by FluxAlg::execute().

virtual std::string IFluxSvc::fluxName (   )  const [pure virtual]

name of the flux Implemented in FluxSvc.

virtual std::list<std::string> IFluxSvc::fluxNames (   )  const [pure virtual]

return a list of legal names Implemented in FluxSvc.

virtual CLHEP::HepRandomEngine* IFluxSvc::getRandomEngine (   )  [pure virtual]

return pointer to the random engine that FluxSvc uses Implemented in FluxSvc.

virtual astro::GPS* IFluxSvc::GPSinstance (   )  [pure virtual]

return pointer to the GPS instance of FluxSVc Implemented in FluxSvc.

virtual bool IFluxSvc::insideSAA (   )  [pure virtual]

return current SAA status Implemented in FluxSvc.

const InterfaceID& IFluxSvc::interfaceID (   )  [inline, static]

Retrieve interface ID. Definition at line 63 of file IFluxSvc.h. { return IID_IFluxSvc; }

virtual std::pair<double,double> IFluxSvc::location (   )  [pure virtual]

get the current satellite location Implemented in FluxSvc.

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

pass a specific amount of time Implemented in FluxSvc.

virtual void IFluxSvc::rootDisplay (  std::vector< std::string >  arguments  )  [pure virtual]

create a set of display windows using rootplot. Implemented in FluxSvc.

virtual void IFluxSvc::setAlignmentRotation (  double  qx, double  qy, double  qz, bool  misalign = false )  [pure virtual]

set aligmnment for Glast. Parameters: qx,qy,qz  x, y, z rotation angles (radians) asssumed small misalign  [false] set true to apply as a misalignment Implemented in FluxSvc. Referenced by FluxAlg::initialize().

virtual void IFluxSvc::setFilterCone (  std::vector< double >  cone  )  [pure virtual]

set filter cone parameters (ra, dec, radius) Implemented in FluxSvc. Referenced by FluxAlg::initialize().

virtual void IFluxSvc::setPointingDirection (  const astro::SkyDir &  dir  )  [pure virtual]

set the pointing direction Implemented in FluxSvc. Referenced by FluxAlg::initialize().

virtual std::vector<double> IFluxSvc::setRockType (  astro::GPS::RockType  rockType, double  rockAngle )  [pure virtual]

set the type of rocking, along with the angle to rock to. 0 = NONE : No rocking rotation done at all. 1 = UPDOWN : Satellite will be rocked toward the north pole in the northern hemisphere, opposite in the south. 2 = SLEWING : (experimental) like UPDOWN, except that rotation at equator happens gradually. 3 = ONEPERORBIT : (needs work) LAT rocked northward for one orbit, southward for the next. 4 = EXPLICIT : Explicit angles given - this should be used with the setExplicit... function. 5 = POINT: Explicit pointing direction given - setExplicitRockingAngles are (l,b). 6 = HISTORY - Filename given to stand for a pre-recorded pointing history. Use the setPointingHistoryFile function. Implemented in FluxSvc. Referenced by FluxAlg::initialize().

virtual void IFluxSvc::setSAABoundary (  const std::vector< std::pair< double, double > > &  boundary  )  [pure virtual]

set the SAA boundary Parameters: boundard  set of (lat, lon) pairs of the polygon Implemented in FluxSvc.

virtual StatusCode IFluxSvc::source (  std::string  name, IFlux *&  )  [pure virtual]

just get an IFlux object by name -- see compositeSource Implemented in FluxSvc. Referenced by FluxAlg::initialize().

virtual std::vector<std::pair< std::string ,std::list<std::string> > > IFluxSvc::sourceOriginList (   )  const [pure virtual]

this should return the source file names, along with the contained sources. Implemented in FluxSvc.

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

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

virtual CLHEP::HepRotation IFluxSvc::transformToGlast (  double  seconds, astro::GPS::CoordSystem  index )  const [pure virtual]

---

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

• IFluxSvc.h

---