A class to represent time instant with time zone. More...

#include <TimeInstantTZ.h>

Inheritance diagram for te::dt::TimeInstantTZ:

Public Member Functions
AbstractData *	clone () const
	It returns a clone of this object.

Date	getDate () const
	It returns the date associated to time instant.

DateTimeType	getDateTimeType () const
	It returns the subtype of the date and time type.

TimeDuration	getTime () const
	It returns the time duration associated to time instant.

boost::local_time::local_date_time &	getTimeInstantTZ ()
	It returns the boost time instant with time zone type.

const boost::local_time::local_date_time &	getTimeInstantTZ () const
	It returns the boost time instant with time zone type.

int	getTypeCode () const
	It returns the data type code associated to date and time values: DATETIME_TYPE.

bool	operator!= (const DateTime &rhs) const
	Operator !=.

long	operator- (const TimeInstantTZ &rhs) const
	Operator -.

bool	operator< (const DateTime &rhs) const
	Operator <.

bool	operator== (const DateTime &rhs) const
	Operator ==.

bool	operator> (const DateTime &rhs) const
	Operator >

	TimeInstantTZ (const boost::local_time::local_date_time &t)
	Constructor.

std::string	toString () const
	It returns the time instant with time zone in the ISO textual format (YYYYMMDDThhmmss?hhmm).

virtual	~TimeInstantTZ ()
	Constructor.

Protected Attributes
boost::local_time::local_date_time	m_timeInstantTZ
	Time instant with time zone information.

Detailed Description

A class to represent time instant with time zone.

A time instant is a point on the continuous time axis. A time instant with time zone is composed of a date that uses the Gregorian calendar and of a time with an associated time zone. Internally, it uses the datetime boost library to represent time instant with time zone, by using the data type boost::local_time::local_date_time.

See also: DateTime, Date, DatePeriod, DateDuration, TimeInstant, TimePeriod, TimeDuration, TimePeriodTZ

Definition at line 56 of file TimeInstantTZ.h.

Constructor & Destructor Documentation

◆ TimeInstantTZ()

te::dt::TimeInstantTZ::TimeInstantTZ ( const boost::local_time::local_date_time & t )

Constructor.

Parameters

t	A time instant with time zone.

Referenced by operator-().

◆ ~TimeInstantTZ()

virtual te::dt::TimeInstantTZ::~TimeInstantTZ ( )

virtual

Constructor.

Member Function Documentation

◆ clone()

AbstractData * te::dt::TimeInstantTZ::clone ( ) const

virtual

It returns a clone of this object.

Returns: A clone of this object.

Implements te::dt::AbstractData.

◆ getDate()

Date te::dt::TimeInstantTZ::getDate ( ) const

It returns the date associated to time instant.

Returns: The date

◆ getDateTimeType()

DateTimeType te::dt::TimeInstantTZ::getDateTimeType ( ) const

inlinevirtual

It returns the subtype of the date and time type.

Returns: The subtype of the date and time type.

Implements te::dt::DateTime.

Definition at line 159 of file TimeInstantTZ.h.

References te::dt::TIME_INSTANT_TZ.

◆ getTime()

TimeDuration te::dt::TimeInstantTZ::getTime ( ) const

It returns the time duration associated to time instant.

Returns: The time duration

◆ getTimeInstantTZ() [1/2]

boost::local_time::local_date_time & te::dt::TimeInstantTZ::getTimeInstantTZ ( )

inline

It returns the boost time instant with time zone type.

Returns: The boost time instant with time zone type.

Definition at line 79 of file TimeInstantTZ.h.

References m_timeInstantTZ.

◆ getTimeInstantTZ() [2/2]

const boost::local_time::local_date_time & te::dt::TimeInstantTZ::getTimeInstantTZ ( ) const

inline

It returns the boost time instant with time zone type.

Returns: The boost time instant with time zone type.

Definition at line 72 of file TimeInstantTZ.h.

References m_timeInstantTZ.

Referenced by te::pgis::Internal2TimeStampTZ().

◆ getTypeCode()

int te::dt::DateTime::getTypeCode ( ) const

inlinevirtualinherited

It returns the data type code associated to date and time values: DATETIME_TYPE.

Returns: The data type code associated to the date and time values: DATETIME_TYPE.

Implements te::dt::AbstractData.

Definition at line 103 of file DateTime.h.

References te::dt::DATETIME_TYPE.

◆ operator!=()

bool te::dt::TimeInstantTZ::operator!= ( const DateTime & rhs ) const

virtual

Operator !=.

Parameters

rhs	The time instant to be compared.

Returns: It returns true if the two time instants are not equal. Otherwise, it returns false.

Implements te::dt::DateTime.

◆ operator-()

long te::dt::TimeInstantTZ::operator- ( const TimeInstantTZ & rhs ) const

Operator -.

Parameters

rhs	The right-hand-side time instant.

Returns: It returns the number of seconds between the two time instants.

References TimeInstantTZ().

◆ operator<()

bool te::dt::TimeInstantTZ::operator< ( const DateTime & rhs ) const

virtual

Operator <.

Parameters

rhs	The right-hand-side time instant to be compared.

Returns: It returns true if the right-hand-side time instant is greater than the lefth side one. Otherwise, it returns false.

Implements te::dt::DateTime.

◆ operator==()

bool te::dt::TimeInstantTZ::operator== ( const DateTime & rhs ) const

virtual

Operator ==.

Parameters

rhs	The time instant to be compared.

Returns: It returns true if the two time instants are equal. Otherwise, it returns false.

Implements te::dt::DateTime.

◆ operator>()

bool te::dt::TimeInstantTZ::operator> ( const DateTime & rhs ) const

virtual

Operator >

Parameters

rhs	The right-hand-side time instant to be compared.

Returns: It returns true if the right-hand-side time instant is less than the lefth side one. Otherwise, it returns false.

Implements te::dt::DateTime.

◆ toString()

std::string te::dt::TimeInstantTZ::toString ( ) const

virtual

It returns the time instant with time zone in the ISO textual format (YYYYMMDDThhmmss?hhmm).

Returns: The time instant with time zone in the ISO textual format (YYYYMMDDThhmmss?hhmm).

Implements te::dt::AbstractData.

Member Data Documentation

◆ m_timeInstantTZ

boost::local_time::local_date_time te::dt::TimeInstantTZ::m_timeInstantTZ

protected

Time instant with time zone information.

Definition at line 166 of file TimeInstantTZ.h.

Referenced by getTimeInstantTZ(), and getTimeInstantTZ().

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/datatype/TimeInstantTZ.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeInstantTZ()

◆ ~TimeInstantTZ()

Member Function Documentation

◆ clone()

◆ getDate()

◆ getDateTimeType()

◆ getTime()

◆ getTimeInstantTZ() [1/2]

◆ getTimeInstantTZ() [2/2]

◆ getTypeCode()

◆ operator!=()

◆ operator-()

◆ operator<()

◆ operator==()

◆ operator>()

◆ toString()

Member Data Documentation

◆ m_timeInstantTZ