OrbElemStore Class Reference
[Ephemstore]

#include <OrbElemStore.hpp>

Inheritance diagram for OrbElemStore:

[legend]Collaboration diagram for OrbElemStore:

[legend]List of all members.

---

Detailed Description

Abstract base class for storing and accessing an objects position, velocity, and clock data.

Also defines a simple interface to remove data that has been added.

Definition at line 63 of file OrbElemStore.hpp.

Public Member Functions
	OrbElemStore () throw ()
virtual	~OrbElemStore ()
virtual Xvt	getXvt (const SatID &id, const CommonTime &t) const =0 throw ( InvalidRequest )
	Returns the position, velocity, and clock offset of the indicated object in ECEF coordinates (meters) at the indicated time.
virtual void	dump (std::ostream &s=std::cout, short detail=0) const throw ()
	A debugging function that outputs in human readable form, all data stored in this object.
virtual void	edit (const CommonTime &tmin, const CommonTime &tmax=CommonTime::END_OF_TIME)=0 throw ()
	Edit the dataset, removing data outside the indicated time interval.
virtual void	clear (void)=0 throw ()
	Clear the dataset, meaning remove all data.
virtual CommonTime	getInitialTime () const =0 throw ()
	Determine the earliest time for which this object can successfully determine the Xvt for any object.
virtual CommonTime	getFinalTime () const =0 throw ()
	Determine the latest time for which this object can successfully determine the Xvt for any object.
virtual bool	velocityIsPresent () const =0 throw ()
virtual bool	hasVelocity () const =0 throw ()
	Return true if velocity data is present in the store.
virtual bool	isPresent (const SatID &id) const =0 throw ()
	Return true if the given SatID is present in the store.

---

Constructor & Destructor Documentation

OrbElemStore (   )  throw () [inline]

Definition at line 67 of file OrbElemStore.hpp.

virtual ~OrbElemStore (   )  [inline, virtual]

Definition at line 72 of file OrbElemStore.hpp.

---

Member Function Documentation

virtual void clear (  void   )  throw () [pure virtual]

Clear the dataset, meaning remove all data. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual void dump (  std::ostream &  s = std::cout, short  detail = 0 )  const throw () [inline, virtual]

A debugging function that outputs in human readable form, all data stored in this object. Parameters: [in]  s  the stream to receive the output; defaults to cout [in]  detail  the level of detail to provide Implements XvtStore< SatID >. Reimplemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore. Definition at line 91 of file OrbElemStore.hpp.

virtual void edit (  const CommonTime &  tmin, const CommonTime &  tmax = CommonTime::END_OF_TIME )  throw () [pure virtual]

Edit the dataset, removing data outside the indicated time interval. Parameters: [in]  tmin  defines the beginning of the time interval [in]  tmax  defines the end of the time interval Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual CommonTime getFinalTime (   )  const throw () [pure virtual]

Determine the latest time for which this object can successfully determine the Xvt for any object. Returns: The final time Exceptions: InvalidRequest  This is thrown if the object has no data. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual CommonTime getInitialTime (   )  const throw () [pure virtual]

Determine the earliest time for which this object can successfully determine the Xvt for any object. Returns: The initial time Exceptions: InvalidRequest  This is thrown if the object has no data. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual Xvt getXvt (  const SatID &  id, const CommonTime &  t )  const throw ( InvalidRequest ) [pure virtual]

Returns the position, velocity, and clock offset of the indicated object in ECEF coordinates (meters) at the indicated time. Parameters: [in]  id  the object's identifier [in]  t  the time to look up Returns: the Xvt of the object at the indicated time Exceptions: InvalidRequest  If the request can not be completed for any reason, this is thrown. The text may have additional information as to why the request failed. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual bool hasVelocity (   )  const throw () [pure virtual]

Return true if velocity data is present in the store. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual bool isPresent (  const SatID &  id  )  const throw () [pure virtual]

Return true if the given SatID is present in the store. Implements XvtStore< SatID >. Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

virtual bool velocityIsPresent (   )  const throw () [pure virtual]

Implemented in GalEphemerisStore, GPSAlmanacStore, GPSEphemerisStore, and GPSOrbElemStore.

---

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

• OrbElemStore.hpp

---