XvtStore Class Template Reference
[Ephemstore]

#include <XvtStore.hpp>

Inheritance diagram for XvtStore:

[legend]List of all members.

---

Detailed Description

template<class IndexType>
class gpstk::XvtStore< IndexType >

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 67 of file src/XvtStore.hpp.

Public Member Functions
virtual	~XvtStore ()
virtual Xvt	getXvt (const IndexType id, const DayTime &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 DayTime &tmin, const DayTime &tmax=DayTime(DayTime::END_OF_TIME))=0 throw ()
	Edit the dataset, removing data outside the indicated time interval.
virtual DayTime	getInitialTime () const =0 throw (InvalidRequest)
	Determine the earliest time for which this object can successfully determine the Xvt for any object.
virtual DayTime	getFinalTime () const =0 throw (InvalidRequest)
	Determine the latest time for which this object can successfully determine the Xvt for any object.
virtual bool	velocityIsPresent () const =0 throw ()
virtual bool	clockIsPresent () const =0 throw ()

---

Constructor & Destructor Documentation

virtual ~XvtStore (   )  [inline, virtual]

Definition at line 70 of file src/XvtStore.hpp.

---

Member Function Documentation

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

Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, and TabularEphemerisStore.

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 Reimplemented in GloEphemerisStore, GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, RinexEphemerisStore, SP3EphemerisStore, and TabularEphemerisStore. Definition at line 90 of file src/XvtStore.hpp.

virtual void edit (  const DayTime &  tmin, const DayTime &  tmax = DayTime(DayTime::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 Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, and TabularEphemerisStore.

virtual DayTime getFinalTime (   )  const throw (InvalidRequest) [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. Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, and TabularEphemerisStore.

virtual DayTime getInitialTime (   )  const throw (InvalidRequest) [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. Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, and TabularEphemerisStore.

virtual Xvt getXvt (  const IndexType  id, const DayTime &  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. Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, MSCStore, and TabularEphemerisStore. Referenced by CorrectedEphemerisRange::ComputeAtReceiveTime(), CorrectedEphemerisRange::ComputeAtTransmitSvTime(), and CorrectedEphemerisRange::ComputeAtTransmitTime().

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

Implemented in GPSAlmanacStore, MSCStore, GPSAlmanacStore, GPSEphemerisStore, MSCStore, and TabularEphemerisStore.

---

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

• src/XvtStore.hpp

---