Helper type to represent frequency differences aka offsets. More...

#include <frequency.hh>

Inheritance diagram for FrequencyOffset:

Collaboration diagram for FrequencyOffset:

Public Member Functions
	FrequencyOffset ()
	Default constructor.

	FrequencyOffset (const FrequencyOffset &other)
	Copy constructor.

FrequencyOffset &	operator= (const FrequencyOffset &other)
	Assignment.

FrequencyOffset	invert () const
	Invert an offset.

FrequencyOffset	abs () const
	Returns a positive frequency offset.

Public Member Functions inherited from FrequencyBase
	FrequencyBase (const FrequencyBase &other)
	Copy constructor.

FrequencyBase &	operator= (const FrequencyBase &other)
	Assignment.

bool	isNegative () const
	Returns `true` of the frequency is negative.

bool	isPositive () const
	Returns `true` of the frequency is positive.

bool	isZero () const
	Returns `true` of the frequency is zero.

QString	format (Unit unit=Unit::Auto) const
	Format the frequency.

bool	parse (const QString &value, Qt::CaseSensitivity caseSensitivity=Qt::CaseInsensitive)
	Parses a frequency.

long long	inHz () const
	Unit conversion.

double	inkHz () const
	Unit conversion.

double	inMHz () const
	Unit conversion.

double	inGHz () const
	Unit conversion.

Unit	unit () const
	Returns the most appropriate unit for the frequency value.

Unit	unitFromString (const QString &input) const
	Returns unit as type base on string input.

bool	isMultipleOf (Unit unit) const
	Checks if frequency is a multiple of unit.

Static Public Member Functions
static FrequencyOffset	fromString (const QString &freq)
	Parses an offset.

static FrequencyOffset	fromHz (qint64 Hz)
	Unit conversion.

static FrequencyOffset	fromkHz (double kHz)
	Unit conversion.

static FrequencyOffset	fromMHz (double MHz)
	Unit conversion.

static FrequencyOffset	fromGHz (double GHz)
	Unit conversion.

Static Public Member Functions inherited from FrequencyBase
static QString	unitName (Unit unit)
	Helper for string conversion of unit.

Protected Member Functions
	FrequencyOffset (qint64 Hz)
	Hidden constructor.

Protected Member Functions inherited from FrequencyBase
	FrequencyBase (qint64 hz)
	Hidden constructor from offset in Hz.

Additional Inherited Members
Public Types inherited from FrequencyBase
enum class	Unit { Auto , Hz , kHz , MHz , GHz }
	Frequency units.

Protected Attributes inherited from FrequencyBase
qint64	_frequency
	The actual frequency in Hz.

Detailed Description

Helper type to represent frequency differences aka offsets.

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

Public Member Functions