Frequency Class Reference

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. More...

Detailed Description

Represents a frequency.

Definition at line 17 of file Frequency.h.

Constructor & Destructor Documentation

Frequency()

Frequency

(

const Duration &

cycleDuration

)

Definition at line 15 of file Frequency.cpp.

Here is the caller graph for this function:

Member Function Documentation

Hertz()

Frequency Hertz ( std::int64_t  hertz )

static

Definition at line 23 of file Frequency.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

HertzDouble()

Frequency HertzDouble ( double  hertz )

static

Definition at line 34 of file Frequency.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool operator!=

(

const Frequency &

rhs

)

const

Definition at line 234 of file Frequency.cpp.

operator*() [1/3]

Frequency operator*

(

double

rhs

)

const

Definition at line 116 of file Frequency.cpp.

Here is the call graph for this function:

operator*() [2/3]

Frequency operator*

(

int

rhs

)

const

Definition at line 123 of file Frequency.cpp.

Here is the call graph for this function:

operator*() [3/3]

Frequency operator*

(

std::int64_t

rhs

)

const

Definition at line 130 of file Frequency.cpp.

Here is the call graph for this function:

operator*=() [1/3]

Frequency & operator*=

(

double

rhs

)

Definition at line 137 of file Frequency.cpp.

operator*=() [2/3]

Frequency & operator*=

(

int

rhs

)

Definition at line 145 of file Frequency.cpp.

operator*=() [3/3]

Frequency & operator*=

(

std::int64_t

rhs

)

Definition at line 153 of file Frequency.cpp.

operator+()

Frequency operator+

(

const Frequency &

rhs

)

const

Definition at line 86 of file Frequency.cpp.

Here is the call graph for this function:

operator+=()

Frequency & operator+=

(

const Frequency &

rhs

)

Definition at line 93 of file Frequency.cpp.

Here is the call graph for this function:

operator-()

Frequency operator-

(

const Frequency &

rhs

)

const

Definition at line 101 of file Frequency.cpp.

Here is the call graph for this function:

operator-=()

Frequency & operator-=

(

const Frequency &

rhs

)

Definition at line 108 of file Frequency.cpp.

Here is the call graph for this function:

operator/() [1/4]

double operator/

(

const Frequency &

rhs

)

const

Definition at line 161 of file Frequency.cpp.

Here is the call graph for this function:

operator/() [2/4]

Frequency operator/

(

double

rhs

)

const

Definition at line 168 of file Frequency.cpp.

Here is the call graph for this function:

operator/() [3/4]

Frequency operator/

(

int

rhs

)

const

Definition at line 175 of file Frequency.cpp.

Here is the call graph for this function:

operator/() [4/4]

Frequency operator/

(

std::int64_t

rhs

)

const

Definition at line 182 of file Frequency.cpp.

Here is the call graph for this function:

operator/=() [1/3]

Frequency & operator/=

(

double

rhs

)

Definition at line 189 of file Frequency.cpp.

operator/=() [2/3]

Frequency & operator/=

(

int

rhs

)

Definition at line 197 of file Frequency.cpp.

operator/=() [3/3]

Frequency & operator/=

(

std::int64_t

rhs

)

Definition at line 205 of file Frequency.cpp.

operator<()

bool operator<

(

const Frequency &

rhs

)

const

Definition at line 213 of file Frequency.cpp.

operator<=()

bool operator<=

(

const Frequency &

rhs

)

const

Definition at line 220 of file Frequency.cpp.

operator==()

bool operator==

(

const Frequency &

rhs

)

const

Definition at line 227 of file Frequency.cpp.

operator>()

bool operator>

(

const Frequency &

rhs

)

const

Definition at line 248 of file Frequency.cpp.

operator>=()

bool operator>=

(

const Frequency &

rhs

)

const

Definition at line 241 of file Frequency.cpp.

toCycleDuration()

Duration toCycleDuration

(

)

const

Definition at line 67 of file Frequency.cpp.

Here is the caller graph for this function:

toFrequencyString()

std::string toFrequencyString

(

)

const

Definition at line 74 of file Frequency.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toHertz()

std::int64_t toHertz

(

)

const

Definition at line 45 of file Frequency.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toHertzDouble()

double toHertzDouble

(

)

const

Definition at line 56 of file Frequency.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_cycleDuration

Duration _cycleDuration

protected

Current cycle duration.

Definition at line 87 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