TimeSystem Class Reference

#include <TimeSystem.hpp>

List of all members.


Detailed Description

This class encapsulates time systems, including std::string I/O.

This is an example of a 'smart enum' class.

Definition at line 49 of file TimeSystem.hpp.

Public Types

enum  Systems {
  Unknown = 0, Any, GPS, GLO,
  GAL, COM, UTC, UT1,
  TAI, TT, count
}
 list of time systems supported by this class More...

Public Member Functions

 TimeSystem (Systems sys=Unknown) throw ()
 Constructor, including empty constructor.
 TimeSystem (int i) throw ()
 constructor from int
void setTimeSystem (const Systems &sys) throw ()
 set the time system
Systems getTimeSystem () const throw ()
 get the time system
std::string asString () const throw ()
 Return a std::string for each system (these strings are const and static).
void fromString (const std::string str) throw ()
 define system based on input string
bool operator== (const TimeSystem &right) const throw ()
 boolean operator==
bool operator< (const TimeSystem &right) const throw ()
 boolean operator< (used by STL to sort)
bool operator!= (const TimeSystem &right) const throw ()
 boolean operator!=
bool operator>= (const TimeSystem &right) const throw ()
 boolean operator>=
bool operator<= (const TimeSystem &right) const throw ()
 boolean operator<=
bool operator> (const TimeSystem &right) const throw ()
 boolean operator>


Member Enumeration Documentation

enum Systems
 

list of time systems supported by this class

Enumeration values:
Unknown  unknown time frame; for legacy code compatibility
Any  wildcard; allows comparison with any other type
GPS  GPS system time.
GLO  GLONASS system time.
GAL  Galileo system time.
COM  Compass system time(BeiDou Time, BDT).
UTC  Coordinated Universal Time (e.g., from NTP).
UT1  UT0 corrected for polar wandering.
TAI  International Atomic Time.
TT  Terrestial Time.
count  the number of systems - not a system

Definition at line 54 of file TimeSystem.hpp.


Constructor & Destructor Documentation

TimeSystem Systems  sys = Unknown  )  throw () [inline]
 

Constructor, including empty constructor.

Definition at line 76 of file TimeSystem.hpp.

TimeSystem int  i  )  throw () [inline]
 

constructor from int

Definition at line 85 of file TimeSystem.hpp.


Member Function Documentation

std::string asString  )  const throw () [inline]
 

Return a std::string for each system (these strings are const and static).

Returns:
the std::string

Definition at line 104 of file TimeSystem.hpp.

Referenced by CommonTime::asString(), TabularSatStore< ClockRecord >::checkTimeSystem(), SP3EphemerisStore::loadRinexClockFile(), and gpstk::operator<<().

void fromString const std::string  str  )  throw ()
 

define system based on input string

Parameters:
str input string, expected to match output string for given system

Definition at line 72 of file TimeSystem.cpp.

Referenced by SP3Data::reallyGetRecord().

Systems getTimeSystem  )  const throw () [inline]
 

get the time system

Definition at line 99 of file TimeSystem.hpp.

bool operator!= const TimeSystem right  )  const throw () [inline]
 

boolean operator!=

Definition at line 121 of file TimeSystem.hpp.

References gpstk::operator==().

bool operator< const TimeSystem right  )  const throw () [inline]
 

boolean operator< (used by STL to sort)

Definition at line 116 of file TimeSystem.hpp.

bool operator<= const TimeSystem right  )  const throw () [inline]
 

boolean operator<=

Definition at line 129 of file TimeSystem.hpp.

References gpstk::operator<(), and gpstk::operator==().

bool operator== const TimeSystem right  )  const throw () [inline]
 

boolean operator==

Definition at line 112 of file TimeSystem.hpp.

bool operator> const TimeSystem right  )  const throw () [inline]
 

boolean operator>

Definition at line 133 of file TimeSystem.hpp.

References gpstk::operator<(), and gpstk::operator==().

bool operator>= const TimeSystem right  )  const throw () [inline]
 

boolean operator>=

Definition at line 125 of file TimeSystem.hpp.

References gpstk::operator<().

void setTimeSystem const Systems sys  )  throw ()
 

set the time system

Definition at line 63 of file TimeSystem.cpp.

Referenced by SP3EphemerisStore::loadRinexClockFile().


The documentation for this class was generated from the following files:
Generated on Sun May 19 03:31:54 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1