Public Member Functions | List of all members
gnsstk::QZSWeekSecond Class Reference

Detailed Description

This class handles the week and seconds-of-week of the QZS TimeTag classes. The QZS week is specified by (GPS without the rollover) 16-bit ModWeek, rollover at 65535, bitmask 0xFFFF and epoch QZS_EPOCH_MJD

Definition at line 56 of file QZSWeekSecond.hpp.

#include <QZSWeekSecond.hpp>

Inheritance diagram for gnsstk::QZSWeekSecond:
Inheritance graph
[legend]

Public Member Functions

int bitmask (void) const
 Return the bitmask used to get the ModWeek from the full week. More...
 
virtual std::string getDefaultFormat () const
 Return a string containing the default format to use in printing. More...
 
virtual std::string getPrintChars () const
 
long MJDEpoch (void) const
 Return the Modified Julian Date (MJD) of epoch for this system. More...
 
int Nbits (void) const
 
virtual std::string printError (const std::string &fmt) const
 
virtual std::string printf (const std::string &fmt) const
 
 QZSWeekSecond (const CommonTime &right)
 Constructor from CommonTime. More...
 
 QZSWeekSecond (unsigned int w=0, double s=0., TimeSystem ts=TimeSystem::QZS)
 Constructor. More...
 
bool setFromInfo (const IdToValue &info)
 
 ~QZSWeekSecond ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::WeekSecond
 WeekSecond (unsigned int w=0, double s=0., TimeSystem ts=TimeSystem::Unknown)
 
 WeekSecond (const WeekSecond &right)
 
 WeekSecond (const TimeTag &right)
 
 WeekSecond (const CommonTime &right)
 
WeekSecondoperator= (const WeekSecond &right)
 
virtual ~WeekSecond ()
 Virtual Destructor. More...
 
virtual CommonTime convertToCommonTime () const
 
virtual void convertFromCommonTime (const CommonTime &ct)
 
virtual bool isValid () const
 Returns true if this object's members are valid, false otherwise. More...
 
virtual void reset ()
 Reset this object to the default state. More...
 
virtual unsigned int getDayOfWeek () const
 Force this interface on this classes descendants. More...
 
double getSOW () const
 
bool operator== (const WeekSecond &right) const
 
bool operator!= (const WeekSecond &right) const
 
bool operator< (const WeekSecond &right) const
 
bool operator> (const WeekSecond &right) const
 
bool operator<= (const WeekSecond &right) const
 
bool operator>= (const WeekSecond &right) const
 
- Public Member Functions inherited from gnsstk::Week
int MAXWEEK (void) const
 
Weekoperator= (const Week &right)
 Assignment Operator. More...
 
virtual int rollover (void) const
 
 Week (int w=0, TimeSystem ts=TimeSystem::Unknown)
 Constructor. More...
 
virtual ~Week ()
 Virtual Destructor. More...
 
bool operator== (const Week &right) const
 
bool operator!= (const Week &right) const
 
bool operator< (const Week &right) const
 
bool operator<= (const Week &right) const
 
bool operator> (const Week &right) const
 
bool operator>= (const Week &right) const
 
virtual unsigned int getWeek () const
 
virtual unsigned int getModWeek () const
 
virtual unsigned int getEpoch () const
 
virtual void getEpochModWeek (unsigned int &e, unsigned int &w) const
 
virtual void setEpoch (unsigned int e)
 
virtual void setModWeek (unsigned int w)
 
virtual void setEpochModWeek (unsigned int e, unsigned int w)
 
virtual void adjustToYear (unsigned int y)
 
- Public Member Functions inherited from gnsstk::TimeTag
virtual std::string asString () const
 
bool changeTimeSystem (TimeSystem timeSys)
 
bool changeTimeSystem (TimeSystem timeSys, TimeSystemConverter *conv)
 
TimeSystem getTimeSystem () const
 Obtain time system info (enum). More...
 
virtual operator CommonTime () const
 
virtual void scanf (const std::string &str, const std::string &fmt)
 
void setTimeSystem (const TimeSystem &timeSys)
 Set method for internal variable timeSystem (enum). More...
 
 TimeTag ()
 Default constructor. More...
 
 TimeTag (const TimeSystem &ts)
 Constructor. More...
 
virtual ~TimeTag ()
 Virtual Destructor. More...
 

Additional Inherited Members

- Public Types inherited from gnsstk::TimeTag
typedef std::map< char, std::string > IdToValue
 
- Static Public Member Functions inherited from gnsstk::TimeTag
static void checkTimeSystem (TimeSystem ts1, TimeSystem ts2)
 
static std::string getError ()
 This returns the default error string for the TimeTag classes. More...
 
static std::string getFormatPrefixFloat ()
 
static std::string getFormatPrefixInt ()
 
static void getInfo (const std::string &str, const std::string &fmt, IdToValue &info)
 
- Public Attributes inherited from gnsstk::WeekSecond
double sow
 
- Public Attributes inherited from gnsstk::Week
int week
 Full week number. More...
 
- Protected Attributes inherited from gnsstk::TimeTag
TimeSystem timeSystem
 time system (representation) of the data More...
 

Constructor & Destructor Documentation

◆ QZSWeekSecond() [1/2]

gnsstk::QZSWeekSecond::QZSWeekSecond ( unsigned int  w = 0,
double  s = 0.,
TimeSystem  ts = TimeSystem::QZS 
)
inline

Constructor.

Definition at line 61 of file QZSWeekSecond.hpp.

◆ QZSWeekSecond() [2/2]

gnsstk::QZSWeekSecond::QZSWeekSecond ( const CommonTime right)
inline

Constructor from CommonTime.

Definition at line 68 of file QZSWeekSecond.hpp.

◆ ~QZSWeekSecond()

gnsstk::QZSWeekSecond::~QZSWeekSecond ( )
inline

Destructor.

Definition at line 74 of file QZSWeekSecond.hpp.

Member Function Documentation

◆ bitmask()

int gnsstk::QZSWeekSecond::bitmask ( void  ) const
inlinevirtual

Return the bitmask used to get the ModWeek from the full week.

Implements gnsstk::Week.

Definition at line 86 of file QZSWeekSecond.hpp.

◆ getDefaultFormat()

virtual std::string gnsstk::QZSWeekSecond::getDefaultFormat ( ) const
inlinevirtual

Return a string containing the default format to use in printing.

Reimplemented from gnsstk::Week.

Definition at line 107 of file QZSWeekSecond.hpp.

◆ getPrintChars()

virtual std::string gnsstk::QZSWeekSecond::getPrintChars ( ) const
inlinevirtual

Return a string containing the characters that this class understands when printing times.

Reimplemented from gnsstk::Week.

Definition at line 101 of file QZSWeekSecond.hpp.

◆ MJDEpoch()

long gnsstk::QZSWeekSecond::MJDEpoch ( void  ) const
inlinevirtual

Return the Modified Julian Date (MJD) of epoch for this system.

Implements gnsstk::Week.

Definition at line 93 of file QZSWeekSecond.hpp.

◆ Nbits()

int gnsstk::QZSWeekSecond::Nbits ( void  ) const
inlinevirtual

Return the number of bits in the bitmask used to get the ModWeek from the full week.

Implements gnsstk::Week.

Definition at line 79 of file QZSWeekSecond.hpp.

◆ printError()

virtual std::string gnsstk::QZSWeekSecond::printError ( const std::string &  fmt) const
inlinevirtual

This function works similarly to printf. Instead of filling the format with data, it fills with error messages.

Implements gnsstk::TimeTag.

Definition at line 140 of file QZSWeekSecond.hpp.

◆ printf()

virtual std::string gnsstk::QZSWeekSecond::printf ( const std::string &  fmt) const
inlinevirtual

This function formats this time to a string. The exceptions thrown would only be due to problems parsing the fmt string.

Implements gnsstk::TimeTag.

Definition at line 114 of file QZSWeekSecond.hpp.

◆ setFromInfo()

bool gnsstk::QZSWeekSecond::setFromInfo ( const IdToValue info)
inlinevirtual

Set this object using the information provided in info.

Parameters
infothe IdToValue object to which this object shall be set.
Returns
true if this object was successfully set using the data in info, false if not.

Implements gnsstk::TimeTag.

Definition at line 168 of file QZSWeekSecond.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:45