a class for time date manipulation More...

#include <time-definitions.h>

Collaboration diagram for woss::Time:

Public Member Functions
	Time ()

	Time (struct tm *time)

	Time (int day, int month, int year, int hours=0, int mins=0, int seconds=1)

	Time (const Time &copy)

	~Time ()

Time &	setMonth (int m)

Time &	setDay (int d)

Time &	setYear (int y)

Time &	setHours (int h)

Time &	setMinutes (int m)

Time &	setSeconds (int s)

bool	isValid () const

int	getMonth () const

int	getDay () const

int	getHours () const

int	getYear () const

int	getMinutes () const

int	getSeconds () const

	operator time_t () const

Time &	operator= (const Time &copy)

friend::std::ostream &	operator<< (::std::ostream &os, const Time &instance)

Static Public Member Functions
static void	setDebug (bool flag)

Protected Attributes
struct tm	timeinfo

time_t	raw_time

Static Protected Attributes
static bool	debug = false

Friends
const Time	operator+ (const Time &left, const time_t right)

const Time	operator- (const Time &left, const time_t right)

double	operator- (const Time &left, const Time &right)

Time &	operator+= (Time &left, time_t right)

Time &	operator-= (Time &left, time_t right)

bool	operator== (const Time &left, const Time &right)

bool	operator!= (const Time &left, const Time &right)

bool	operator> (const Time &left, const Time &right)

bool	operator< (const Time &left, const Time &right)

bool	operator<= (const Time &left, const Time &right)

bool	operator>= (const Time &left, const Time &right)

Detailed Description

a class for time date manipulation

Time class offers the possibility to store and manipulate date time. A time date consists of a day, month, year, hours, minutes and seconds.

Constructor & Destructor Documentation

◆ Time() [1/4]

Time::Time ( )

Default Time constructor. Object is not valid

References raw_time, and timeinfo.

◆ Time() [2/4]

Time::Time ( struct tm * time )

Time constructor

Parameters

time	struct tm from ctime library

References raw_time, and timeinfo.

◆ Time() [3/4]

Time::Time	(	int	day,
		int	month,
		int	year,
		int	hours = `0`,
		int	mins = `0`,
		int	seconds = `1`
	)

Time constructor

Parameters

day	day value. Should be between 1 and 31
month	month value. Should be between 1 and 12
year	year value.
hours	hours value. Should be between 0 and 23
mins	minutes value. Should be between 0 and 59
seconds	seconds value. Should be between 0 and 59

References raw_time, and timeinfo.

◆ Time() [4/4]

Time::Time ( const Time & copy )

Time copy constructor

Parameters

copy	TimeArr to be copied

References raw_time, and timeinfo.

◆ ~Time()

woss::Time::~Time ( )

inline

Time destructor. It is not virtual, since this class is not meant to be inherited from

Member Function Documentation

◆ getDay()

int woss::Time::getDay ( ) const

inline

Returns day value

Returns: day value between 1 and 31

References timeinfo.

◆ getHours()

int woss::Time::getHours ( ) const

inline

Returns hours value

Returns: hours value between 0 and 23

References timeinfo.

◆ getMinutes()

int woss::Time::getMinutes ( ) const

inline

Returns minutes value

Returns: minutes value between 0 and 59

References timeinfo.

◆ getMonth()

int woss::Time::getMonth ( ) const

inline

Returns month value

Returns: month value between 1 and 12

References timeinfo.

◆ getSeconds()

int woss::Time::getSeconds ( ) const

inline

Returns seconds value

Returns: seconds value between 0 and 59

References timeinfo.

◆ getYear()

int woss::Time::getYear ( ) const

inline

Returns year value

Returns: year value

References timeinfo.

◆ isValid()

bool woss::Time::isValid ( ) const

inline

Checks the validity of Time

Returns: true if it has a initialized date time, false otherwise

References raw_time.

Referenced by woss::BellhopCreator::createWoss(), woss::ResPressureTxtDb::getValue(), woss::ResTimeArrTxtDb::getValue(), woss::WossManagerResDbMT::getWossPressure(), woss::WossManager::getWossPressure(), woss::WossManagerResDbMT::getWossTimeArr(), woss::WossManager::getWossTimeArr(), woss::ACToolboxWoss::isValid(), woss::BellhopWoss::timeEvolve(), woss::Altimetry::timeEvolve(), woss::AltimBretschneider::timeEvolve(), woss::WMSMTcreateThreadPressure(), woss::WMSMTcreateThreadTimeArr(), and woss::Woss::Woss().

◆ operator time_t()

woss::Time::operator time_t ( ) const

inline

time_t operator

Returns: the time_t

◆ operator<<()

friend::std::ostream & woss::Time::operator<<	(	::std::ostream &	os,
		const Time &	instance
	)

<< operator

Parameters

os	left operand ostream reference
instance	right operand const Time reference

Returns: os reference after the operation

◆ operator=()

Time & Time::operator= ( const Time & copy )

Assignment operator

Parameters

copy	const reference to a Time object to be copied

Returns: Time reference to this

References raw_time, and timeinfo.

◆ setDay()

Time & woss::Time::setDay ( int d )

inline

Sets day

Parameters

d	day value. Should be between 1 and 31

Returns: reference to *this

References raw_time, and timeinfo.

◆ setDebug()

static void woss::Time::setDebug ( bool flag )

inlinestatic

Sets debug flag for all instances

Parameters

flag	debug bool

References debug.

◆ setHours()

Time & woss::Time::setHours ( int h )

inline

Sets hours

Parameters

m	hours value. Should be between 0 and 23

Returns: reference to *this

References raw_time, and timeinfo.

◆ setMinutes()

Time & woss::Time::setMinutes ( int m )

inline

Sets minutes

Parameters

m	minutes value. Should be between 0 and 59

Returns: reference to *this

References raw_time, and timeinfo.

◆ setMonth()

Time & woss::Time::setMonth ( int m )

inline

Sets month

Parameters

m	month value. Should be between 1 and 12

Returns: reference to *this

References raw_time, and timeinfo.

◆ setSeconds()

Time & woss::Time::setSeconds ( int s )

inline

Sets seconds

Parameters

s	seconds value. Should be between 0 and 59

Returns: reference to *this

References raw_time, and timeinfo.

◆ setYear()

Time & woss::Time::setYear ( int y )

inline

Sets year

Parameters

y	year value

Returns: reference to *this

References raw_time, and timeinfo.

Friends And Related Function Documentation

◆ operator!=

bool operator!=	(	const Time &	left,
		const Time &	right
	)

friend

Inequality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left != right, false otherwise

◆ operator+

const Time operator+	(	const Time &	left,
		const time_t	right
	)

friend

Sum operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator+=

Time & operator+=	(	Time &	left,
		time_t	right
	)

friend

Compound assignment sum operator

Parameters

left	left operand reference
right	right operand const time_t representing seconds

Returns: left reference after the operation

◆ operator- [1/2]

double operator-	(	const Time &	left,
		const Time &	right
	)

friend

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: time difference in seconds

◆ operator- [2/2]

const Time operator-	(	const Time &	left,
		const time_t	right
	)

friend

Subtraction operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: a new const instance holding the operation result

◆ operator-=

Time & operator-=	(	Time &	left,
		time_t	right
	)

friend

Compound assignment subtraction operator

Parameters

left	left operand reference
right	right operand const time_t representing seconds

Returns: left reference after the operation

◆ operator<

bool operator<	(	const Time &	left,
		const Time &	right
	)

friend

Less than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left < right, false otherwise

◆ operator<=

bool operator<=	(	const Time &	left,
		const Time &	right
	)

friend

Less than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left <= right, false otherwise

◆ operator==

bool operator==	(	const Time &	left,
		const Time &	right
	)

friend

Equality operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left == right, false otherwise

◆ operator>

bool operator>	(	const Time &	left,
		const Time &	right
	)

friend

Greater than operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left > right, false otherwise

◆ operator>=

bool operator>=	(	const Time &	left,
		const Time &	right
	)

friend

Greater than or equal to operator

Parameters

left	left operand const reference
right	right operand const reference

Returns: true if left >= right, false otherwise

Member Data Documentation

◆ debug

bool Time::debug = false

staticprotected

Debug flag

Referenced by setDebug().

◆ raw_time

time_t woss::Time::raw_time

protected

Number of seconds corresponding to date time timeinfo

Referenced by isValid(), woss::operator+=(), woss::operator-=(), operator=(), setDay(), setHours(), setMinutes(), setMonth(), setSeconds(), setYear(), and Time().

◆ timeinfo

struct tm woss::Time::timeinfo

protected

Struct tm from ctime library

Referenced by getDay(), getHours(), getMinutes(), getMonth(), getSeconds(), getYear(), woss::operator+=(), woss::operator-(), woss::operator-=(), operator=(), setDay(), setHours(), setMinutes(), setMonth(), setSeconds(), setYear(), and Time().

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

woss/woss_def/time-definitions.h
woss/woss_def/time-definitions.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Time() [1/4]

◆ Time() [2/4]

◆ Time() [3/4]

◆ Time() [4/4]

◆ ~Time()

Member Function Documentation

◆ getDay()

◆ getHours()

◆ getMinutes()

◆ getMonth()

◆ getSeconds()

◆ getYear()

◆ isValid()

◆ operator time_t()

◆ operator<<()

◆ operator=()

◆ setDay()

◆ setDebug()

◆ setHours()

◆ setMinutes()

◆ setMonth()

◆ setSeconds()

◆ setYear()

Friends And Related Function Documentation

◆ operator!=

◆ operator+

◆ operator+=

◆ operator- [1/2]

◆ operator- [2/2]

◆ operator-=

◆ operator<

◆ operator<=

◆ operator==

◆ operator>

◆ operator>=

Member Data Documentation

◆ debug

◆ raw_time

◆ timeinfo