#include <DODS_Decimal_Year.h>

Collaboration diagram for DODS_Decimal_Year:

Public Member Functions
Constructors
	DODS_Decimal_Year ()

	DODS_Decimal_Year (DODS_Date d)

	DODS_Decimal_Year (DODS_Date d, DODS_Time t)

	DODS_Decimal_Year (string date_time)

	DODS_Decimal_Year (BaseType *date_time)

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

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

Assignment
void	set (DODS_Date d)

void	set (DODS_Date d, DODS_Time t)

void	set (string date_time)

void	set (BaseType *date_time)

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

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

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

double	julian_day () const

time_t	unix_time () const

Relational operators
double	get_epsilon () const

void	set_epsilon (double eps)

bool	OK () const

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

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

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

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

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

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

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() [1/7]

DODS_Decimal_Year::DODS_Decimal_Year ( )

Create an empty instance. Will not pass the class invariant.

Definition at line 86 of file DODS_Decimal_Year.cc.

◆ DODS_Decimal_Year() [2/7]

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() [3/7]

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.

Definition at line 90 of file DODS_Decimal_Year.cc.

◆ DODS_Decimal_Year() [4/7]

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.

Definition at line 94 of file DODS_Decimal_Year.cc.

◆ DODS_Decimal_Year() [5/7]

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

Definition at line 99 of file DODS_Decimal_Year.cc.

◆ DODS_Decimal_Year() [6/7]

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.

Definition at line 104 of file DODS_Decimal_Year.cc.

◆ DODS_Decimal_Year() [7/7]

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.

Definition at line 110 of file DODS_Decimal_Year.cc.

Member Function Documentation

◆ days_in_year()

int DODS_Decimal_Year::days_in_year ( ) const

Returns: The number of days in the year.

Definition at line 234 of file DODS_Decimal_Year.cc.

◆ fraction()

double DODS_Decimal_Year::fraction ( ) const

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

Definition at line 243 of file DODS_Decimal_Year.cc.

◆ get()

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.

Definition at line 266 of file DODS_Decimal_Year.cc.

◆ get_epsilon()

double DODS_Decimal_Year::get_epsilon ( ) const

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

Definition at line 300 of file DODS_Decimal_Year.cc.

◆ gmt()

bool DODS_Decimal_Year::gmt ( ) const

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

Definition at line 260 of file DODS_Decimal_Year.cc.

◆ julian_day()

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.

Definition at line 279 of file DODS_Decimal_Year.cc.

◆ OK()

bool DODS_Decimal_Year::OK ( ) const

Class invariant.

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

Definition at line 81 of file DODS_Decimal_Year.cc.

◆ set() [1/6]

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

Definition at line 204 of file DODS_Decimal_Year.cc.

◆ set() [2/6]

void DODS_Decimal_Year::set ( DODS_Date d )

Set an instance using DODS_Date objects.

Parameters

d	A DODS_Date object.

Definition at line 117 of file DODS_Decimal_Year.cc.

◆ set() [3/6]

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.

Definition at line 125 of file DODS_Decimal_Year.cc.

◆ set() [4/6]

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.

Definition at line 210 of file DODS_Decimal_Year.cc.

◆ set() [5/6]

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.

Definition at line 219 of file DODS_Decimal_Year.cc.

◆ set() [6/6]

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.

Definition at line 134 of file DODS_Decimal_Year.cc.

◆ set_epsilon()

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.

Definition at line 306 of file DODS_Decimal_Year.cc.

◆ unix_time()

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)

Definition at line 285 of file DODS_Decimal_Year.cc.

◆ year()

int DODS_Decimal_Year::year ( ) const

Returns: The year in years A.D.

Definition at line 228 of file DODS_Decimal_Year.cc.

Friends And Related Symbol Documentation

◆ operator!=

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

friend

Inequality.

Definition at line 318 of file DODS_Decimal_Year.cc.

◆ operator<

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

friend

Less-than.

Definition at line 323 of file DODS_Decimal_Year.cc.

◆ operator<=

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

friend

Less-than or Equal-to.

Definition at line 337 of file DODS_Decimal_Year.cc.

◆ operator==

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

friend

Equality.

Definition at line 312 of file DODS_Decimal_Year.cc.

◆ operator>

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

friend

Greater-than.

Definition at line 331 of file DODS_Decimal_Year.cc.

◆ operator>=

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

friend

Greater-than or Equal-to.

Definition at line 344 of file DODS_Decimal_Year.cc.

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

Public Member Functions

Relational operators

Detailed Description

Constructor & Destructor Documentation

◆ DODS_Decimal_Year() [1/7]

◆ DODS_Decimal_Year() [2/7]

◆ DODS_Decimal_Year() [3/7]

◆ DODS_Decimal_Year() [4/7]

◆ DODS_Decimal_Year() [5/7]

◆ DODS_Decimal_Year() [6/7]

◆ DODS_Decimal_Year() [7/7]

Member Function Documentation

◆ days_in_year()

◆ fraction()

◆ get()

◆ get_epsilon()

◆ gmt()

◆ julian_day()

◆ OK()

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ set_epsilon()

◆ unix_time()

◆ year()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=