Detailed Description

This class encapsulates the "ANSITime (seconds since Unix epoch)" time representation.

Definition at line 56 of file ANSITime.hpp.

#include <ANSITime.hpp>

Inheritance diagram for gnsstk::ANSITime:

Public Member Functions
ANSITime Basic Operations
	ANSITime (time_t t=0, const TimeSystem &ts=TimeSystem::Unknown)

	ANSITime (const ANSITime &right)

	ANSITime (const TimeTag &right)

	ANSITime (const CommonTime &right)

ANSITime &	operator= (const ANSITime &right)

virtual	~ANSITime () noexcept
	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...

ANSITime Comparison Operators
All comparison operators have a parameter "right" which corresponds to the ANSITime object to the right of the symbol. All comparison operators are const and return true on success and false on failure.
time_t	time

bool	operator== (const ANSITime &right) const

bool	operator!= (const ANSITime &right) const

bool	operator< (const ANSITime &right) const

bool	operator> (const ANSITime &right) const

bool	operator<= (const ANSITime &right) const

bool	operator>= (const ANSITime &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

◆ ANSITime() [1/4]

gnsstk::ANSITime::ANSITime	(	time_t	t = `0`,
		const TimeSystem &	ts = `TimeSystem::Unknown`
	)

inline

Default Constructor. All elements are initialized to zero.

Definition at line 68 of file ANSITime.hpp.

◆ ANSITime() [2/4]

gnsstk::ANSITime::ANSITime ( const ANSITime & right )

inline

Copy Constructor.

Parameters

right a reference to the ANSITime object to copy

Definition at line 77 of file ANSITime.hpp.

◆ ANSITime() [3/4]

gnsstk::ANSITime::ANSITime ( 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 88 of file ANSITime.hpp.

◆ ANSITime() [4/4]

gnsstk::ANSITime::ANSITime ( 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 100 of file ANSITime.hpp.

◆ ~ANSITime()

virtual gnsstk::ANSITime::~ANSITime ( )

inlinevirtualnoexcept

Virtual Destructor.

Definition at line 113 of file ANSITime.hpp.

Member Function Documentation

◆ convertFromCommonTime()

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

virtual

Exceptions

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

This is the earliest CommonTime for which ANSITimes are valid, = UNIX_MJD = 40587 = Jan 1 1970

This is the latest CommonTime for which ANSITimes are valid. 2^31 - 1 seconds = Jan 19 2038 3:14:7

Implements gnsstk::TimeTag.

Definition at line 71 of file ANSITime.cpp.

◆ convertToCommonTime()

CommonTime gnsstk::ANSITime::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 ANSITime.cpp.

◆ getDefaultFormat()

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

inlinevirtual

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

Implements gnsstk::TimeTag.

Definition at line 147 of file ANSITime.hpp.

◆ getPrintChars()

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

inlinevirtual

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

Implements gnsstk::TimeTag.

Definition at line 141 of file ANSITime.hpp.

◆ isValid()

bool gnsstk::ANSITime::isValid ( ) const

virtual

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

Implements gnsstk::TimeTag.

Definition at line 157 of file ANSITime.cpp.

◆ operator!=()

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

Definition at line 190 of file ANSITime.cpp.

◆ operator<()

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

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

Definition at line 195 of file ANSITime.cpp.

◆ operator<=()

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

Definition at line 214 of file ANSITime.cpp.

◆ operator=()

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

Assignment Operator.

Parameters

right a const reference to the ANSITime to copy

Returns: a reference to this ANSITime

Definition at line 47 of file ANSITime.cpp.

◆ operator==()

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

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

Definition at line 174 of file ANSITime.cpp.

◆ operator>()

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

Definition at line 209 of file ANSITime.cpp.

◆ operator>=()

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

Definition at line 220 of file ANSITime.cpp.

◆ printError()

std::string gnsstk::ANSITime::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 113 of file ANSITime.cpp.

◆ printf()

std::string gnsstk::ANSITime::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 94 of file ANSITime.cpp.

◆ reset()

void gnsstk::ANSITime::reset ( )

virtual

Reset this object to the default state.

Implements gnsstk::TimeTag.

Definition at line 168 of file ANSITime.cpp.

◆ setFromInfo()

bool gnsstk::ANSITime::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 132 of file ANSITime.cpp.

Member Data Documentation

◆ time

time_t gnsstk::ANSITime::time

Definition at line 172 of file ANSITime.hpp.

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

Detailed Description

Public Member Functions

ANSITime Comparison Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ ANSITime() [1/4]

◆ ANSITime() [2/4]

◆ ANSITime() [3/4]

◆ ANSITime() [4/4]

◆ ~ANSITime()

Member Function Documentation

◆ convertFromCommonTime()

◆ convertToCommonTime()

◆ getDefaultFormat()

◆ getPrintChars()

◆ isValid()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ printError()

◆ printf()

◆ reset()

◆ setFromInfo()

Member Data Documentation

◆ time