bpf::system::TimeSpan class
#include <Base/include/Framework/System/TimeSpan.hpp>

Contents

Represents a time span

Constructors, destructors, conversion operators

TimeSpan(uint64 seconds = 0) explicit noexcept
TimeSpan(fint days, fint hours, fint minutes, fint seconds) explicit noexcept

Public functions

auto operator+(const TimeSpan& other) const -> TimeSpan noexcept
auto operator-(const TimeSpan& other) const -> TimeSpan noexcept
auto operator>(const TimeSpan& other) const -> bool noexcept
auto operator<(const TimeSpan& other) const -> bool noexcept
auto operator<=(const TimeSpan& other) const -> bool noexcept
auto operator>=(const TimeSpan& other) const -> bool noexcept
auto operator==(const TimeSpan& other) const -> bool noexcept
auto operator!=(const TimeSpan& other) const -> bool noexcept
void operator+=(const TimeSpan& other) noexcept
void operator-=(const TimeSpan& other) noexcept

Public variables

fint Days
fint Hours
fint Minutes
fint Seconds
uint64 TotalSeconds

Function documentation

bpf::system::TimeSpan::TimeSpan(uint64 seconds = 0) explicit noexcept

Parameters
seconds number of seconds, use 0 to denote empty TimeSpan

Constructs a TimeSpan from a number of seconds

bpf::system::TimeSpan::TimeSpan(fint days, fint hours, fint minutes, fint seconds) explicit noexcept

Parameters
days day count
hours hour count
minutes minute count
seconds second count

Constructs a TimeSpan from individual components

TimeSpan bpf::system::TimeSpan::operator+(const TimeSpan& other) const noexcept

Parameters
other operand
Returns new TimeSpan

Adds two time spans

TimeSpan bpf::system::TimeSpan::operator-(const TimeSpan& other) const noexcept

Parameters
other operand
Returns new TimeSpan

Subtracts two time spans

bool bpf::system::TimeSpan::operator>(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is greater than other, false otherwise

Compare TimeSpan

bool bpf::system::TimeSpan::operator<(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is less than other, false otherwise

Compare TimeSpan

bool bpf::system::TimeSpan::operator<=(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is less than or equal to other, false otherwise

Compare TimeSpan

bool bpf::system::TimeSpan::operator>=(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is less than or equal to other, false otherwise

Compare TimeSpan

bool bpf::system::TimeSpan::operator==(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is equal to other, false otherwise

Compare TimeSpan

bool bpf::system::TimeSpan::operator!=(const TimeSpan& other) const noexcept

Parameters
other operand
Returns true if this is not equal to other, false otherwise

Compare TimeSpan

void bpf::system::TimeSpan::operator+=(const TimeSpan& other) noexcept

Parameters
other the other TimeSpan to add

Adds a TimeSpan

void bpf::system::TimeSpan::operator-=(const TimeSpan& other) noexcept

Parameters
other the other TimeSpan to subtract

Subtracts a TimeSpan

Variable documentation

fint bpf::system::TimeSpan::Days

Day count

fint bpf::system::TimeSpan::Hours

Hour count

fint bpf::system::TimeSpan::Minutes

Minute count

fint bpf::system::TimeSpan::Seconds

Second count

uint64 bpf::system::TimeSpan::TotalSeconds

Total time contained in this span expressed as a number of seconds