Detailed Description

This class encapsulates the "Modified Julian Date" time representation.

Definition at line 54 of file MJD.hpp.

#include <MJD.hpp>

Inheritance diagram for gnsstk::MJD:

Public Member Functions
MJD Basic Operations
	MJD (long double m=0., TimeSystem ts=TimeSystem::Unknown)

	MJD (const MJD &right)

	MJD (const TimeTag &right)

	MJD (const CommonTime &right)

MJD &	operator= (const MJD &right)

virtual	~MJD ()
	Virtual Destructor. More...

virtual CommonTime	convertToCommonTime () const

virtual void	convertFromCommonTime (const CommonTime &ct)

virtual std::string	printf (const std::string &fmt) const

virtual std::string	printError (const std::string &fmt) const

virtual bool	setFromInfo (const IdToValue &info)

virtual std::string	getPrintChars () const

virtual std::string	getDefaultFormat () const
	Return a string containing the default format to use in printing. More...

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...

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...

MJD Comparison Operators
All comparison operators have a parameter "right" which corresponds to the MJD object to the right of the symbol. All comparison operators are const and return true on success and false on failure.
long double	mjd

bool	operator== (const MJD &right) const

bool	operator!= (const MJD &right) const

bool	operator< (const MJD &right) const

bool	operator> (const MJD &right) const

bool	operator<= (const MJD &right) const

bool	operator>= (const MJD &right) const

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)

Protected Attributes inherited from gnsstk::TimeTag
TimeSystem	timeSystem
	time system (representation) of the data More...

Constructor & Destructor Documentation

◆ MJD() [1/4]

gnsstk::MJD::MJD	(	long double	m = `0.`,
		TimeSystem	ts = `TimeSystem::Unknown`
	)

inline

Default Constructor. All elements are initialized to zero.

Definition at line 66 of file MJD.hpp.

◆ MJD() [2/4]

gnsstk::MJD::MJD ( const MJD & right )

inline

Copy Constructor.

Parameters

right a reference to the MJD object to copy

Definition at line 75 of file MJD.hpp.

◆ MJD() [3/4]

gnsstk::MJD::MJD ( const TimeTag & right )

inline

Alternate Copy Constructor. Takes a const TimeTag reference and copies its contents via conversion to CommonTime.

Parameters

right a const reference to the BasicTime object to copy

Exceptions

InvalidRequest on over-/under-flow

Definition at line 86 of file MJD.hpp.

◆ MJD() [4/4]

gnsstk::MJD::MJD ( const CommonTime & right )

inline

Alternate Copy Constructor. Takes a const CommonTime reference and copies its contents via the convertFromCommonTime method.

Parameters

right a const reference to the CommonTime object to copy

Exceptions

InvalidRequest on over-/under-flow

Definition at line 98 of file MJD.hpp.

◆ ~MJD()

virtual gnsstk::MJD::~MJD ( )

inlinevirtual

Virtual Destructor.

Definition at line 111 of file MJD.hpp.

Member Function Documentation

◆ convertFromCommonTime()

void gnsstk::MJD::convertFromCommonTime ( const CommonTime & ct )

virtual

Exceptions

InvalidRequest if ct cannot be correctly represented in this TimeTag object.

Implements gnsstk::TimeTag.

Definition at line 84 of file MJD.cpp.

◆ convertToCommonTime()

CommonTime gnsstk::MJD::convertToCommonTime ( ) const

virtual

Exceptions

InvalidRequest if this TimeTag cannot be correctly represented by a CommonTime object.

Implements gnsstk::TimeTag.

Definition at line 54 of file MJD.cpp.

◆ getDefaultFormat()

virtual std::string gnsstk::MJD::getDefaultFormat ( ) const

inlinevirtual

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

Implements gnsstk::TimeTag.

Definition at line 144 of file MJD.hpp.

◆ getPrintChars()

virtual std::string gnsstk::MJD::getPrintChars ( ) const

inlinevirtual

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

Implements gnsstk::TimeTag.

Definition at line 138 of file MJD.hpp.

◆ isValid()

bool gnsstk::MJD::isValid ( ) const

virtual

Returns true if this object's members are valid, false otherwise.

Implements gnsstk::TimeTag.

Definition at line 158 of file MJD.cpp.

◆ operator!=()

bool gnsstk::MJD::operator!= ( const MJD & right ) const

Definition at line 190 of file MJD.cpp.

◆ operator<()

bool gnsstk::MJD::operator< ( const MJD & right ) const

Any (wildcard) type exception allowed, otherwise must be same time systems

Definition at line 195 of file MJD.cpp.

◆ operator<=()

bool gnsstk::MJD::operator<= ( const MJD & right ) const

Definition at line 218 of file MJD.cpp.

◆ operator=()

MJD & gnsstk::MJD::operator= ( const MJD & right )

Assignment Operator.

Parameters

right a const reference to the MJD to copy

Returns: a reference to this MJD

Definition at line 47 of file MJD.cpp.

◆ operator==()

bool gnsstk::MJD::operator== ( const MJD & right ) const

Any (wildcard) type exception allowed, otherwise must be same time systems

Definition at line 175 of file MJD.cpp.

◆ operator>()

bool gnsstk::MJD::operator> ( const MJD & right ) const

Definition at line 213 of file MJD.cpp.

◆ operator>=()

bool gnsstk::MJD::operator>= ( const MJD & right ) const

Definition at line 224 of file MJD.cpp.

◆ printError()

std::string gnsstk::MJD::printError ( const std::string & fmt ) const

virtual

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

Implements gnsstk::TimeTag.

Definition at line 114 of file MJD.cpp.

◆ printf()

std::string gnsstk::MJD::printf ( const std::string & fmt ) const

virtual

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 95 of file MJD.cpp.

◆ reset()

void gnsstk::MJD::reset ( )

virtual

Reset this object to the default state.

Implements gnsstk::TimeTag.

Definition at line 169 of file MJD.cpp.

◆ setFromInfo()

bool gnsstk::MJD::setFromInfo ( const IdToValue & info )

virtual

Set this object using the information provided in info.

Parameters

info	the 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 133 of file MJD.cpp.

Member Data Documentation

◆ mjd

long double gnsstk::MJD::mjd

Definition at line 169 of file MJD.hpp.

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

Detailed Description

Public Member Functions

MJD Comparison Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ MJD() [1/4]

◆ MJD() [2/4]

◆ MJD() [3/4]

◆ MJD() [4/4]

◆ ~MJD()

Member Function Documentation

◆ convertFromCommonTime()

◆ convertToCommonTime()

◆ getDefaultFormat()

◆ getPrintChars()

◆ isValid()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ printError()

◆ printf()

◆ reset()

◆ setFromInfo()

Member Data Documentation

◆ mjd