The DODS Date/Time class is used to represent and compute the new decimal_year values. More...

#include <DODS_Decimal_Year.h>

Collaboration diagram for DODS_Decimal_Year:

Public Member Functions
double	get_epsilon () const
	Get the value of epsilon used for equality tests of time. More...

bool	OK () const
	Class invariant. More...

void	set_epsilon (double eps)
	Set the value of epsilon used for equality tests of time. More...

Constructors
	DODS_Decimal_Year ()
	Create an empty instance. More...

	DODS_Decimal_Year (DODS_Date d)
	Create an instance using DODS_Date and DODS_Time objects. More...

	DODS_Decimal_Year (DODS_Date d, DODS_Time t)
	Create an instance using DODS_Date and DODS_Time objects. More...

	DODS_Decimal_Year (string date_time)
	Create an instance using the string representation of a DODS_Date_Time. More...

	DODS_Decimal_Year (BaseType *date_time)
	Create an instance using the string representation of a DODS_Date_Time contained in a DODS Str. More...

	DODS_Decimal_Year (int y, int m, int d, int hh=0, int mm=0, double ss=0.0, bool gmt=false)
	Create an instance using numeric values for the year, ..., seconds. More...

	DODS_Decimal_Year (int y, int yd, int hh=0, int mm=0, double ss=0.0, bool gmt=false)
	Create an instance using numeric values for the year, ..., seconds. More...

Assignment
void	set (DODS_Date d)
	Set an instance using DODS_Date objects. More...

void	set (DODS_Date d, DODS_Time t)
	Set an instance using DODS_Date and DODS_Time objects. More...

void	set (string date_time)
	Set an instance using the string representation of a DODS_Date_Time. More...

void	set (BaseType *date_time)
	Set an instance using the string representation of a DODS_Date_Time contained in a DODS Str. More...

void	set (int y, int m, int d, int hh=0, int mm=0, double ss=0.0, bool gmt=false)
	Set an instance using numeric values for the year, ..., seconds. More...

void	set (int y, int yd, int hh=0, int mm=0, double ss=0.0, bool gmt=false)
	Set an instance using numeric values for the year, ..., seconds. More...

Access
int	days_in_year () const

int	year () const

double	fraction () const

bool	gmt () const

string	get (date_format format=ymd, bool gmt=true) const
	Get the string representation of the date/time. More...

double	julian_day () const

time_t	unix_time () const
	Return the number of seconds since 00:00:00 UTC 1 Jan 1970. More...

Friends
Relational operators
int	operator== (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Equality. More...

int	operator!= (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Inequality. More...

int	operator< (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Less-than. More...

int	operator> (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Greater-than. More...

int	operator<= (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Less-than or Equal-to. More...

int	operator>= (DODS_Decimal_Year &t1, DODS_Decimal_Year &t2)
	Greater-than or Equal-to. More...

Detailed Description

The DODS Date/Time class is used to represent and compute the new decimal_year values.

See also: DODS_Date; DODS_Time

Author: James Gallagher/Dan Holloway

Definition at line 47 of file DODS_Decimal_Year.h.

Constructor & Destructor Documentation

DODS_Decimal_Year::DODS_Decimal_Year ( )

Create an empty instance.

Will not pass the class invariant.

DODS_Decimal_Year::DODS_Decimal_Year ( DODS_Date d )

Create an instance using DODS_Date and DODS_Time objects.

Parameters

d	A DODS_Date object.

DODS_Decimal_Year::DODS_Decimal_Year	(	DODS_Date	d,
		DODS_Time	t
	)

Create an instance using DODS_Date and DODS_Time objects.

Parameters

d	A DODS_Date object.
t	A DODS_Time object.

DODS_Decimal_Year::DODS_Decimal_Year ( string date_time )

Create an instance using the string representation of a DODS_Date_Time.

Parameters

date_time The date/time string.

DODS_Decimal_Year::DODS_Decimal_Year ( BaseType * date_time )

Create an instance using the string representation of a DODS_Date_Time contained in a DODS Str.

Parameters

date_time The date/time string (in a DODS Str pointer).

DODS_Decimal_Year::DODS_Decimal_Year	(	int	y,
		int	m,
		int	d,
		int	hh = `0`,
		int	mm = `0`,
		double	ss = `0.0`,
		bool	gmt = `false`
	)

Create an instance using numeric values for the year, ..., seconds.

Parameters

y	The year number, 1 is 1 A.D.
m	The month, 1 is January, ..., 12 is December.
d	The day.
hh	The hour, 0...23.
mm	The minute, 0...59.
ss	The seconds, 0.0, ..., 59.999...
gmt	True if the time is a GMT time, false otherwise.

DODS_Decimal_Year::DODS_Decimal_Year	(	int	y,
		int	yd,
		int	hh = `0`,
		int	mm = `0`,
		double	ss = `0.0`,
		bool	gmt = `false`
	)

Create an instance using numeric values for the year, ..., seconds.

Parameters

y	The year number, 1 is 1 A.D.
yd	The year-day, 1 is 1 January, 365/366 is 31 December.
hh	The hour, 0...23.
mm	The minute, 0...59.
ss	The seconds, 0.0, ..., 59.999...
gmt	True if the time is a GMT time, false otherwise.

Member Function Documentation

int DODS_Decimal_Year::days_in_year ( ) const

Returns: The number of days in the year.

double DODS_Decimal_Year::fraction ( ) const

Returns: The fractional representation of the year-day, seconds.

string DODS_Decimal_Year::get	(	date_format	format = `ymd`,
		bool	gmt = `true`
	)		const

Get the string representation of the date/time.

If #format# is ymd#, return the date-time using yyyy/mm/dd:hh:mm:ss notation, if it is yd#, use yyyy/ddd... notation. If gmt# is true, append GMT to times that are GMT times, if false, don't (ever) append the GMT suffix.

Parameters

format	The format of the date-part.
gmt	Append the GMT suffix to GMT times.

Returns: The string representation f the date-time.

double DODS_Decimal_Year::get_epsilon ( ) const

Get the value of epsilon used for equality tests of time.

bool DODS_Decimal_Year::gmt ( ) const

Returns: True if the time is a GMT time, false otherwise.

double DODS_Decimal_Year::julian_day ( ) const

Returns: The Julian day number for this date and time. The time part of the day is represented as a fraction.

bool DODS_Decimal_Year::OK ( ) const

Class invariant.

Returns: True if the instance is valid, false otherwise.

void DODS_Decimal_Year::set ( DODS_Date d )

Set an instance using DODS_Date objects.

Parameters

d	A DODS_Date object.

void DODS_Decimal_Year::set	(	DODS_Date	d,
		DODS_Time	t
	)

Set an instance using DODS_Date and DODS_Time objects.

Parameters

d	A DODS_Date object.
t	A DODS_Time object.

void DODS_Decimal_Year::set ( string date_time )

Set an instance using the string representation of a DODS_Date_Time.

Parameters

date_time The date/time string.

void DODS_Decimal_Year::set ( BaseType * date_time )

Set an instance using the string representation of a DODS_Date_Time contained in a DODS Str.

Parameters

date_time The date/time string (in a DODS Str pointer).

void DODS_Decimal_Year::set	(	int	y,
		int	m,
		int	d,
		int	hh = `0`,
		int	mm = `0`,
		double	ss = `0.0`,
		bool	gmt = `false`
	)

Set an instance using numeric values for the year, ..., seconds.

Parameters

y	The year number, 1 is 1 A.D.
m	The month, 1 is January, ..., 12 is December.
d	The day.
hh	The hour, 0...23.
mm	The minute, 0...59.
ss	The seconds, 0.0, ..., 59.999...
gmt	True if the time is a GMT time, false otherwise.

void DODS_Decimal_Year::set	(	int	y,
		int	yd,
		int	hh = `0`,
		int	mm = `0`,
		double	ss = `0.0`,
		bool	gmt = `false`
	)

Set an instance using numeric values for the year, ..., seconds.

Parameters

y	The year number, 1 is 1 A.D.
yd	The year-day, 1 is 1 January, 365/366 is 31 December.
hh	The hour, 0...23.
mm	The minute, 0...59.
ss	The seconds, 0.0, ..., 59.999...
gmt	True if the time is a GMT time, false otherwise.

void DODS_Decimal_Year::set_epsilon ( double eps )

Set the value of epsilon used for equality tests of time.

By default the value is 0.000001 (10e-6).

NB: This should rarely be changed.

time_t DODS_Decimal_Year::unix_time ( ) const

Return the number of seconds since 00:00:00 UTC 1 Jan 1970.

If the date is before 1 Jan 1970, return DODS_UINT_MAX. If the date is too late to represent as seconds since 1 Jan 1970, return DODS_UINT_MAX. Each day starts at 00:00:00 UTC.

Returns: The date in seconds since 1 Jan 1970.

See also: dods-limits.h; time.h; mktime(3)

int DODS_Decimal_Year::year ( ) const

Returns: The year in years A.D.

Friends And Related Function Documentation

int operator!=	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Inequality.

int operator<	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Less-than.

int operator<=	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Less-than or Equal-to.

int operator==	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Equality.

int operator>	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Greater-than.

int operator>=	(	DODS_Decimal_Year &	t1,
		DODS_Decimal_Year &	t2
	)

friend

Greater-than or Equal-to.

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

DODS_Decimal_Year.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation