gem::TimezoneResult Class Reference

Defines a timezone result. More...

Inheritance diagram for gem::TimezoneResult:

Collaboration diagram for gem::TimezoneResult:

Public Member Functions
	TimezoneResult ()=default
	Default constructor.
	TimezoneResult (const TimezoneResult &)=default
	Default copy constructor.
	TimezoneResult (TimezoneResult &&) noexcept=default
	Default move constructor noexcept is deduced.
TimezoneResult &	operator= (const TimezoneResult &other)=default
	Default copy assignment.
TimezoneResult &	operator= (TimezoneResult &&other) noexcept=default
	Default move assignment noexcept is deduced.
bool	operator== (TimezoneResult const &timezoneResult) const
	Compare if two TimezoneResult objects are equal.
bool	operator!= (TimezoneResult const &timezoneResult) const
	Compare if two TimezoneResult objects are not equal.
int	getDstOffset () const noexcept
	Get DST offset.
int	getOffset () const noexcept
	Get the offset including DST.
int	getUtcOffset () const noexcept
	Get the offset without DST.
ETZStatus	getStatus () const noexcept
	Get the status of the response.
const StringRef	getTimezoneId () const noexcept
	Get the ID of the timezone.
Time	getLocalTime () const noexcept
	Get the local time.

Detailed Description

Defines a timezone result.

Implements share-read / copy-on-write Api object over ITimezoneResult.

Member Function Documentation

getDstOffset()

int gem::TimezoneResult::getDstOffset ( ) const

inlinenoexcept

Get DST offset.

Returns

The offset in seconds. Returns 0 if no DST available

getLocalTime()

Time gem::TimezoneResult::getLocalTime ( ) const

inlinenoexcept

Get the local time.

Returns

The local time of the timezone

getOffset()

int gem::TimezoneResult::getOffset ( ) const

inlinenoexcept

Get the offset including DST.

Returns

The offset in seconds

getStatus()

ETZStatus gem::TimezoneResult::getStatus ( ) const

inlinenoexcept

Get the status of the response.

See also

ETZStatus.

Returns

The status of the response

getTimezoneId()

const StringRef gem::TimezoneResult::getTimezoneId ( ) const

inlinenoexcept

Get the ID of the timezone.

Returns

The ID of the timezone

getUtcOffset()

int gem::TimezoneResult::getUtcOffset ( ) const

inlinenoexcept

Get the offset without DST.

Returns

The offset in seconds

operator!=()

bool gem::TimezoneResult::operator!= ( TimezoneResult const & timezoneResult ) const

inline

Compare if two TimezoneResult objects are not equal.

Parameters

timezoneResult

The TimezoneResult object to compare with

Returns

True if the objects are not equal, false otherwise

operator=() [1/2]

TimezoneResult & gem::TimezoneResult::operator= ( const TimezoneResult & other )

default

Default copy assignment.

Parameters

other

The TimezoneResult object to copy

Returns

The reference to this object

operator=() [2/2]

TimezoneResult & gem::TimezoneResult::operator= ( TimezoneResult && other )

defaultnoexcept

Default move assignment noexcept is deduced.

Parameters

other

The TimezoneResult object to move

Returns

The reference to this object

operator==()

bool gem::TimezoneResult::operator== ( TimezoneResult const & timezoneResult ) const

inline

Compare if two TimezoneResult objects are equal.

Parameters

timezoneResult

The TimezoneResult object to compare with

Returns

True if the objects are equal, false otherwise