Parse and return pieces of a time string. More...

#include <iTime.h>

Collaboration diagram for Isis::iTime:

Public Member Functions
	iTime ()
	Constructs an empty iTime object.

	iTime (const QString &time)
	Constructs a iTime object and initializes it to the time from the argument.

	iTime (const double time)
	Constructs a iTime object and initializes it to the time from the argument.

void	operator= (const QString &time)
	Changes the value of the iTime object.

void	operator= (const char *time)

void	operator= (const double time)

bool	operator>= (const iTime &time)
	Compare two iTime objects for greater than or equal.

bool	operator<= (const iTime &time)
	Compare two iTime objects for less than or equal.

bool	operator> (const iTime &time)
	Compare two iTime objects for greater than.

bool	operator< (const iTime &time)
	Compare two iTime objects for less than.

bool	operator!= (const iTime &time)
	Compare two iTime objects for inequality.

bool	operator== (const iTime &time)
	Compare two iTime objects for equality.

iTime	operator+ (const double &secondsToAdd) const

void	operator+= (const double &secondsToAdd)

iTime	operator- (const double &secondsToSubtract) const

double	operator- (const iTime &iTimeToSubtract) const

void	operator-= (const double &secondsToSubtract)

QString	YearString () const
	Returns the year portion of the time as a string.

int	Year () const
	Returns the year portion of the time as an int.

QString	MonthString () const
	Returns the month portion of the time as a string.

int	Month () const
	Returns the month portion of the time as an int.

QString	DayString () const
	Returns the dat portion of the time as a string.

int	Day () const
	Returns the day portion of the time as an int.

QString	HourString () const
	Returns the hour portion of the time as a string.

int	Hour () const
	Returns the hour portion of the time as an int.

QString	MinuteString () const
	Returns the minute portion of the time as a string.

int	Minute () const
	Returns the minute portion of the time as an int.

QString	SecondString () const
	Returns the second portion of the time as a string.

double	Second () const
	Returns the second portion of the time as a double.

QString	DayOfYearString () const
	Returns the day of year portion of the time as a string.

int	DayOfYear () const
	Returns the day of year portion of the time as an int.

QString	EtString () const
	Returns the ephemeris time (TDB) representation of the time as a string.

double	Et () const
	Returns the ephemeris time (TDB) representation of the time as a double.

QString	UTC () const
	Returns the internally stored time, formatted as a UTC time.

void	setEt (double et)

void	setUtc (QString utcString)

Static Public Member Functions
static QString	CurrentGMT ()
	Returns the current Greenwich Mean iTime The time is based on the system time, so it is only as accurate as the local system clock.

static QString	CurrentLocalTime ()
	Returns the current local time This time is taken directly from the system clock, so if the system clock is off, this will be, too.

Private Member Functions
void	LoadLeapSecondKernel ()
	Uses the Naif routines to load the most current leap second kernel.

void	UnloadLeapSecondKernel ()
	Uses the Naif routines to unload the leap second kernel.

Private Attributes
double	p_et
	The ephemeris representaion of the original string passed into the constructor or the operator= member

Static Private Attributes
static bool	p_lpInitialized = false

Friends
iTime	operator+ (const double &secondsToAdd, iTime time)

iTime	operator- (const double &secondsToSubtract, iTime time)

Detailed Description

Parse and return pieces of a time string.

This class parses a date/time string into individual components. The input time string can be in a variety of formats (see the NAIF routine str2et_c). The components and different representation can then be returned using the member functions.

Author: 2003-10-24 Stuart Sides

History:

2003-11-05 Stuart Sides - Fixed error in documentation

2003-12-03 Stuart Sides - Added comparison operators for (>=, <=, >, <, ==, and !=)

2003-12-09 Stuart Sides - Modified so all iTime objects will share the same leap second kernel. This means the leapsecond kernel will be loaded once and never unloaded. Other objects which use the leapsecond kernel should not unload it either.

2005-02-22 Elizabeth Ribelin - Modified file to support Doxygen documentation

2006-03-31 Elizabeth Miller - added UTC method

2006-10-02 Brendan George - Added CurrentLocalTime and CurrentGMT methods

2007-12-07 Kris Becker - Modifed the SecondString() method to always return fixed notation for fractions of a second of no more than 8 digits after the decimal point. It was returning scientific notation causing parsing errors (in NAIF, PostgreSQL TIMESTAMP fields, etc...)

2011-05-25 Janet Barrett and Steven Lambright - Added setUtc, setEt and addition operators

Definition at line 72 of file iTime.h.

Constructor & Destructor Documentation

Isis::iTime::iTime ( )

Constructs an empty iTime object.

Definition at line 44 of file iTime.cpp.

Isis::iTime::iTime ( const QString & time )

Constructs a iTime object and initializes it to the time from the argument.

Parameters

time	A time string formatted in standard UTC or similar format. Example:"2000/12/31 23:59:01.6789" or "2000-12-31T23:59:01.6789"

Definition at line 54 of file iTime.cpp.

Isis::iTime::iTime ( const double time )

inline

Constructs a iTime object and initializes it to the time from the argument.

Parameters

time	An ephemeris time (ET).

Definition at line 83 of file iTime.h.

References LoadLeapSecondKernel(), and p_et.

Member Function Documentation

QString Isis::iTime::CurrentGMT ( )

static

Returns the current Greenwich Mean iTime The time is based on the system time, so it is only as accurate as the local system clock.

Returns: QString The Current GMT

Definition at line 479 of file iTime.cpp.

QString Isis::iTime::CurrentLocalTime ( )

static

Returns the current local time This time is taken directly from the system clock, so if the system clock is off, this will be, too.

Returns: QString The cutrrent local time

Definition at line 495 of file iTime.cpp.

Referenced by Isis::BundleAdjust::errorPropagation_CHOLMOD(), and Isis::BundleAdjust::OutputHeader().

int Isis::iTime::Day ( ) const

Returns the day portion of the time as an int.

Returns: int

Definition at line 286 of file iTime.cpp.

References Isis::IString::ToInteger().

int Isis::iTime::DayOfYear ( ) const

Returns the day of year portion of the time as an int.

Returns: int

Definition at line 382 of file iTime.cpp.

References Isis::IString::ToInteger().

QString Isis::iTime::DayOfYearString ( ) const

Returns the day of year portion of the time as a string.

Returns: string

Definition at line 373 of file iTime.cpp.

References Isis::toString().

QString Isis::iTime::DayString ( ) const

Returns the dat portion of the time as a string.

Returns: string

Definition at line 277 of file iTime.cpp.

References Isis::toString().

double Isis::iTime::Et ( ) const

inline

Returns the ephemeris time (TDB) representation of the time as a double.

Definition at line 133 of file iTime.h.

References p_et.

Referenced by Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::RadarSlantRangeMap::ComputeA(), Isis::Spice::computeSolarLongitude(), Isis::Spice::createCache(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::VimsSkyMap::Init(), Isis::VimsGroundMap::Init(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::MiniRF::MiniRF(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::DawnVirCamera::readHouseKeeping(), Isis::NewHorizonsMvicFrameCamera::SetBand(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::Spice::setTime(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::SsiCamera::SsiCamera(), Isis::Camera::StartEndEphemerisTimes(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::UvvisCamera::UvvisCamera(), Isis::VikingCamera::VikingCamera(), Isis::VimsCamera::VimsCamera(), and Isis::VoyagerCamera::VoyagerCamera().

QString Isis::iTime::EtString ( ) const

Returns the ephemeris time (TDB) representation of the time as a string.

See the Naif documentation "time.req" for more information.

Returns: string

Definition at line 396 of file iTime.cpp.

References Isis::toString().

int Isis::iTime::Hour ( ) const

Returns the hour portion of the time as an int.

Returns: int

Definition at line 308 of file iTime.cpp.

References Isis::IString::ToInteger().

QString Isis::iTime::HourString ( ) const

Returns the hour portion of the time as a string.

Returns: string

Definition at line 299 of file iTime.cpp.

References Isis::toString().

void Isis::iTime::LoadLeapSecondKernel ( )

private

Uses the Naif routines to load the most current leap second kernel.

Definition at line 446 of file iTime.cpp.

References Isis::PvlObject::findGroup().

Referenced by iTime().

int Isis::iTime::Minute ( ) const

Returns the minute portion of the time as an int.

Returns: int

Definition at line 330 of file iTime.cpp.

References Isis::IString::ToInteger().

QString Isis::iTime::MinuteString ( ) const

Returns the minute portion of the time as a string.

Returns: string

Definition at line 321 of file iTime.cpp.

References Isis::toString().

int Isis::iTime::Month ( ) const

Returns the month portion of the time as an int.

Returns: int

Definition at line 264 of file iTime.cpp.

References Isis::IString::ToInteger().

QString Isis::iTime::MonthString ( ) const

Returns the month portion of the time as a string.

Returns: string

Definition at line 255 of file iTime.cpp.

References Isis::toString().

bool Isis::iTime::operator!= ( const iTime & time )

Compare two iTime objects for inequality.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 163 of file iTime.cpp.

References p_et.

bool Isis::iTime::operator< ( const iTime & time )

Compare two iTime objects for less than.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 152 of file iTime.cpp.

References p_et.

bool Isis::iTime::operator<= ( const iTime & time )

Compare two iTime objects for less than or equal.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 129 of file iTime.cpp.

References p_et.

void Isis::iTime::operator= ( const QString & time )

Changes the value of the iTime object.

Parameters

time	A time string formatted in standard UTC or similar format. Example:"2000/12/31 23:59:01.6789" or "2000-12-31T23:59:01.6789"

Definition at line 77 of file iTime.cpp.

bool Isis::iTime::operator== ( const iTime & time )

Compare two iTime objects for equality.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 174 of file iTime.cpp.

References p_et.

bool Isis::iTime::operator> ( const iTime & time )

Compare two iTime objects for greater than.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 140 of file iTime.cpp.

References p_et.

bool Isis::iTime::operator>= ( const iTime & time )

Compare two iTime objects for greater than or equal.

Parameters

time	The iTime object to be compared to "this"

Returns: bool

Definition at line 118 of file iTime.cpp.

References p_et.

double Isis::iTime::Second ( ) const

Returns the second portion of the time as a double.

Returns: double

Definition at line 360 of file iTime.cpp.

References Isis::IString::ToDouble().

QString Isis::iTime::SecondString ( ) const

Returns the second portion of the time as a string.

Returns: string

Definition at line 343 of file iTime.cpp.

void Isis::iTime::UnloadLeapSecondKernel ( )

private

Uses the Naif routines to unload the leap second kernel.

Definition at line 464 of file iTime.cpp.

QString Isis::iTime::UTC ( ) const

Returns the internally stored time, formatted as a UTC time.

Returns: string The internalized time, in UTC format

Definition at line 405 of file iTime.cpp.

int Isis::iTime::Year ( ) const

Returns the year portion of the time as an int.

Returns: int

Definition at line 242 of file iTime.cpp.

References Isis::IString::ToInteger().

QString Isis::iTime::YearString ( ) const

Returns the year portion of the time as a string.

Returns: string

Definition at line 233 of file iTime.cpp.

References Isis::toString().

Member Data Documentation

double Isis::iTime::p_et

private

     The ephemeris representaion of the original string

passed into the constructor or the operator= member

Definition at line 145 of file iTime.h.

Referenced by Et(), iTime(), operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

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

src/base/objs/iTime/iTime.h
src/base/objs/iTime/iTime.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation