Represents a frequency. More...

#include <ArmarXCore/core/time/Frequency.h>

Public Member Functions
	Frequency (const Duration &cycleDuration)

bool	operator!= (const Frequency &rhs) const

Frequency	operator* (double rhs) const

Frequency	operator* (int rhs) const

Frequency	operator* (std::int64_t rhs) const

Frequency &	operator*= (double rhs)

Frequency &	operator*= (int rhs)

Frequency &	operator*= (std::int64_t rhs)

Frequency	operator+ (const Frequency &rhs) const

Frequency &	operator+= (const Frequency &rhs)

Frequency	operator- (const Frequency &rhs) const

Frequency &	operator-= (const Frequency &rhs)

double	operator/ (const Frequency &rhs) const

Frequency	operator/ (double rhs) const

Frequency	operator/ (int rhs) const

Frequency	operator/ (std::int64_t rhs) const

Frequency &	operator/= (double rhs)

Frequency &	operator/= (int rhs)

Frequency &	operator/= (std::int64_t rhs)

bool	operator< (const Frequency &rhs) const

bool	operator<= (const Frequency &rhs) const

bool	operator== (const Frequency &rhs) const

bool	operator> (const Frequency &rhs) const

bool	operator>= (const Frequency &rhs) const

Duration	toCycleDuration () const

std::string	toFrequencyString () const

std::int64_t	toHertz () const

double	toHertzDouble () const

Static Public Member Functions
static Frequency	Hertz (std::int64_t hertz)

static Frequency	HertzDouble (double hertz)

Protected Attributes
Duration	_cycleDuration
	Current cycle duration.

Detailed Description

Represents a frequency.

Definition at line 16 of file Frequency.h.

Constructor & Destructor Documentation

◆ Frequency()

Frequency ( const Duration & cycleDuration )

Definition at line 14 of file Frequency.cpp.

Member Function Documentation

◆ Hertz()

Frequency Hertz ( std::int64_t hertz )

static

Definition at line 20 of file Frequency.cpp.

Here is the caller graph for this function:

◆ HertzDouble()

Frequency HertzDouble ( double hertz )

static

Definition at line 30 of file Frequency.cpp.

Here is the caller graph for this function:

◆ operator!=()

bool operator!= ( const Frequency & rhs ) const

Definition at line 205 of file Frequency.cpp.

◆ operator*() [1/3]

Frequency operator* ( double rhs ) const

Definition at line 103 of file Frequency.cpp.

◆ operator*() [2/3]

Frequency operator* ( int rhs ) const

Definition at line 109 of file Frequency.cpp.

◆ operator*() [3/3]

Frequency operator* ( std::int64_t rhs ) const

Definition at line 115 of file Frequency.cpp.

◆ operator*=() [1/3]

Frequency & operator*= ( double rhs )

Definition at line 121 of file Frequency.cpp.

◆ operator*=() [2/3]

Frequency & operator*= ( int rhs )

Definition at line 128 of file Frequency.cpp.

◆ operator*=() [3/3]

Frequency & operator*= ( std::int64_t rhs )

Definition at line 135 of file Frequency.cpp.

◆ operator+()

Frequency operator+ ( const Frequency & rhs ) const

Definition at line 77 of file Frequency.cpp.

◆ operator+=()

Frequency & operator+= ( const Frequency & rhs )

Definition at line 83 of file Frequency.cpp.

◆ operator-()

Frequency operator- ( const Frequency & rhs ) const

Definition at line 90 of file Frequency.cpp.

◆ operator-=()

Frequency & operator-= ( const Frequency & rhs )

Definition at line 96 of file Frequency.cpp.

◆ operator/() [1/4]

double operator/ ( const Frequency & rhs ) const

Definition at line 142 of file Frequency.cpp.

◆ operator/() [2/4]

Frequency operator/ ( double rhs ) const

Definition at line 148 of file Frequency.cpp.

◆ operator/() [3/4]

Frequency operator/ ( int rhs ) const

Definition at line 154 of file Frequency.cpp.

◆ operator/() [4/4]

Frequency operator/ ( std::int64_t rhs ) const

Definition at line 160 of file Frequency.cpp.

◆ operator/=() [1/3]

Frequency & operator/= ( double rhs )

Definition at line 166 of file Frequency.cpp.

◆ operator/=() [2/3]

Frequency & operator/= ( int rhs )

Definition at line 173 of file Frequency.cpp.

◆ operator/=() [3/3]

Frequency & operator/= ( std::int64_t rhs )

Definition at line 180 of file Frequency.cpp.

◆ operator<()

bool operator< ( const Frequency & rhs ) const

Definition at line 186 of file Frequency.cpp.

◆ operator<=()

bool operator<= ( const Frequency & rhs ) const

Definition at line 192 of file Frequency.cpp.

◆ operator==()

bool operator== ( const Frequency & rhs ) const

Definition at line 199 of file Frequency.cpp.

◆ operator>()

bool operator> ( const Frequency & rhs ) const

Definition at line 217 of file Frequency.cpp.

◆ operator>=()

bool operator>= ( const Frequency & rhs ) const

Definition at line 211 of file Frequency.cpp.

◆ toCycleDuration()

Duration toCycleDuration ( ) const

Definition at line 60 of file Frequency.cpp.

◆ toFrequencyString()

std::string toFrequencyString ( ) const

Definition at line 66 of file Frequency.cpp.

◆ toHertz()

std::int64_t toHertz ( ) const

Definition at line 40 of file Frequency.cpp.

◆ toHertzDouble()

double toHertzDouble ( ) const

Definition at line 50 of file Frequency.cpp.

Member Data Documentation

◆ _cycleDuration

Duration _cycleDuration

protected

Current cycle duration.

Definition at line 86 of file Frequency.h.

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

ArmarXCore/core/time/Frequency.h
ArmarXCore/core/time/Frequency.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes