Sen API
Sen Libraries
Loading...
Searching...
No Matches
sen::Duration Class Referencefinal

A time duration. More...

#include <duration.h>

Inheritance diagram for sen::Duration:

Public Types

using Base = sen::StrongType<int64_t, Duration>
using ValueType = Base::ValueType

Public Member Functions

template<class Rep, class Period>
constexpr Duration (std::chrono::nanoseconds value) noexcept
template<class Rep, class Period>
constexpr Duration (std::chrono::duration< Rep, Period > value) noexcept
 ~Duration () noexcept=default
constexpr ValueType getNanoseconds () const noexcept
 Number of nanoseconds.
constexpr std::chrono::nanoseconds toChrono () const noexcept
 Conversion to std::chrono representation.
constexpr float64_t toSeconds () const noexcept
 Number of seconds.
constexpr std::enable_if_t< HasOperator< std::int64_t >::eq, bool > operator== (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::ne, bool > operator!= (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::lt, bool > operator< (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::le, bool > operator<= (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::gt, bool > operator> (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::ge, bool > operator>= (const Duration &other) const
constexpr std::enable_if_t< HasOperator< std::int64_t >::inc, Duration & > operator++ ()
constexpr std::enable_if_t< HasOperator< std::int64_t >::dec, Duration & > operator-- ()
constexpr std::enable_if_t< HasOperator< std::int64_t >::inc, Duration & > operator+= (const Duration &other) noexcept
constexpr std::enable_if_t< HasOperator< std::int64_t >::dec, Durationoperator+ (const Duration &other) const noexcept
constexpr std::enable_if_t< HasOperator< std::int64_t >::dec, Duration & > operator-= (const Duration &other) noexcept
constexpr std::enable_if_t< HasOperator< std::int64_t >::dec, Durationoperator- (const Duration &other) const noexcept
constexpr std::enable_if_t< HasOperator< std::int64_t >::mul, Durationoperator*= (const Duration &other) noexcept
constexpr std::enable_if_t< HasOperator< std::int64_t >::mul, Durationoperator* (const Duration &other) const noexcept
constexpr std::int64_t get () const noexcept
constexpr void set (const std::int64_t &value) noexcept

Static Public Member Functions

static constexpr Duration fromHertz (float64_t hz) noexcept
 Creates a duration out of a frequency in Hertz.
static constexpr Duration fromHertz (float32_t hz) noexcept
 Creates a duration out of a frequency in Hertz.

Protected Member Functions

constexpr std::int64_t & val () noexcept

Detailed Description

A time duration.

Member Typedef Documentation

◆ Base

◆ ValueType

Constructor & Destructor Documentation

◆ Duration() [1/2]

template<class Rep, class Period>
sen::Duration::Duration ( std::chrono::nanoseconds value)
inlineconstexprnoexcept

◆ Duration() [2/2]

template<class Rep, class Period>
sen::Duration::Duration ( std::chrono::duration< Rep, Period > value)
inlineconstexprnoexcept

◆ ~Duration()

sen::Duration::~Duration ( )
defaultnoexcept

Member Function Documentation

◆ getNanoseconds()

ValueType sen::Duration::getNanoseconds ( ) const
inlinenodiscardconstexprnoexcept

Number of nanoseconds.

◆ toChrono()

std::chrono::nanoseconds sen::Duration::toChrono ( ) const
inlinenodiscardconstexprnoexcept

Conversion to std::chrono representation.

◆ toSeconds()

float64_t sen::Duration::toSeconds ( ) const
inlinenodiscardconstexprnoexcept

Number of seconds.

◆ fromHertz() [1/2]

constexpr Duration sen::Duration::fromHertz ( float64_t hz)
inlinestaticnodiscardconstexprnoexcept

Creates a duration out of a frequency in Hertz.

Precondition
hz != 0.0

◆ fromHertz() [2/2]

constexpr Duration sen::Duration::fromHertz ( float32_t hz)
inlinestaticnodiscardconstexprnoexcept

Creates a duration out of a frequency in Hertz.

Precondition
hz != 0.0

◆ operator==()

std::enable_if_t< HasOperator< std::int64_t >::eq, bool > sen::StrongType< std::int64_t, Duration >::operator== ( const Duration & other) const
inlineconstexprinherited

◆ operator!=()

std::enable_if_t< HasOperator< std::int64_t >::ne, bool > sen::StrongType< std::int64_t, Duration >::operator!= ( const Duration & other) const
inlineconstexprinherited

◆ operator<()

std::enable_if_t< HasOperator< std::int64_t >::lt, bool > sen::StrongType< std::int64_t, Duration >::operator< ( const Duration & other) const
inlineconstexprinherited

◆ operator<=()

std::enable_if_t< HasOperator< std::int64_t >::le, bool > sen::StrongType< std::int64_t, Duration >::operator<= ( const Duration & other) const
inlineconstexprinherited

◆ operator>()

std::enable_if_t< HasOperator< std::int64_t >::gt, bool > sen::StrongType< std::int64_t, Duration >::operator> ( const Duration & other) const
inlineconstexprinherited

◆ operator>=()

std::enable_if_t< HasOperator< std::int64_t >::ge, bool > sen::StrongType< std::int64_t, Duration >::operator>= ( const Duration & other) const
inlineconstexprinherited

◆ operator++()

std::enable_if_t< HasOperator< std::int64_t >::inc, Duration & > sen::StrongType< std::int64_t, Duration >::operator++ ( )
inlineconstexprinherited

◆ operator--()

std::enable_if_t< HasOperator< std::int64_t >::dec, Duration & > sen::StrongType< std::int64_t, Duration >::operator-- ( )
inlineconstexprinherited

◆ operator+=()

std::enable_if_t< HasOperator< std::int64_t >::inc, Duration & > sen::StrongType< std::int64_t, Duration >::operator+= ( const Duration & other)
inlineconstexprnoexceptinherited

◆ operator+()

std::enable_if_t< HasOperator< std::int64_t >::dec, Duration > sen::StrongType< std::int64_t, Duration >::operator+ ( const Duration & other) const
inlineconstexprnoexceptinherited

◆ operator-=()

std::enable_if_t< HasOperator< std::int64_t >::dec, Duration & > sen::StrongType< std::int64_t, Duration >::operator-= ( const Duration & other)
inlineconstexprnoexceptinherited

◆ operator-()

std::enable_if_t< HasOperator< std::int64_t >::dec, Duration > sen::StrongType< std::int64_t, Duration >::operator- ( const Duration & other) const
inlineconstexprnoexceptinherited

◆ operator*=()

std::enable_if_t< HasOperator< std::int64_t >::mul, Duration > sen::StrongType< std::int64_t, Duration >::operator*= ( const Duration & other)
inlineconstexprnoexceptinherited

◆ operator*()

std::enable_if_t< HasOperator< std::int64_t >::mul, Duration > sen::StrongType< std::int64_t, Duration >::operator* ( const Duration & other) const
inlineconstexprnoexceptinherited

◆ get()

std::int64_t sen::StrongTypeBase< std::int64_t >::get ( ) const
inlinenodiscardconstexprnoexceptinherited

◆ set()

void sen::StrongTypeBase< std::int64_t >::set ( const std::int64_t & value)
inlineconstexprnoexceptinherited

◆ val()

std::int64_t & sen::StrongTypeBase< std::int64_t >::val ( )
inlinenodiscardconstexprprotectednoexceptinherited

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