Struct Frequency

Namespace

UnitsNet

Assembly

UnitsNet.Frequency.dll

The number of occurrences of a repeating event per unit time.

public struct Frequency

Constructors

Frequency(double, FrequencyUnit)

Creates the quantity with the given numeric value and unit.

public Frequency(double value, FrequencyUnit unit)

Parameters

value double

The numeric value to construct this quantity with.

unit FrequencyUnit

The unit representation to construct this quantity with.

Exceptions

ArgumentException

If value is NaN or Infinity.

Properties

BUnits

Gets a double value of this quantity converted into BUnit

public double BUnits { get; }

Property Value

double

BaseUnit

The base unit of Frequency, which is Second. All conversions go via this value.

public static FrequencyUnit BaseUnit { get; }

Property Value

FrequencyUnit

BeatsPerMinute

Gets a double value of this quantity converted into BeatPerMinute

public double BeatsPerMinute { get; }

Property Value

double

CyclesPerHour

Gets a double value of this quantity converted into CyclePerHour

public double CyclesPerHour { get; }

Property Value

double

CyclesPerMinute

Gets a double value of this quantity converted into CyclePerMinute

public double CyclesPerMinute { get; }

Property Value

double

Gigahertz

Gets a double value of this quantity converted into Gigahertz

public double Gigahertz { get; }

Property Value

double

Hertz

Gets a double value of this quantity converted into Hertz

public double Hertz { get; }

Property Value

double

Kilohertz

Gets a double value of this quantity converted into Kilohertz

public double Kilohertz { get; }

Property Value

double

MaxValue

Represents the largest possible value of Frequency.

public static Frequency MaxValue { get; }

Property Value

Frequency

Megahertz

Gets a double value of this quantity converted into Megahertz

public double Megahertz { get; }

Property Value

double

Microhertz

Gets a double value of this quantity converted into Microhertz

public double Microhertz { get; }

Property Value

double

Millihertz

Gets a double value of this quantity converted into Millihertz

public double Millihertz { get; }

Property Value

double

MinValue

Represents the smallest possible value of Frequency.

public static Frequency MinValue { get; }

Property Value

Frequency

PerSecond

Gets a double value of this quantity converted into PerSecond

public double PerSecond { get; }

Property Value

double

RadiansPerSecond

Gets a double value of this quantity converted into RadianPerSecond

public double RadiansPerSecond { get; }

Property Value

double

Terahertz

Gets a double value of this quantity converted into Terahertz

public double Terahertz { get; }

Property Value

double

Unit

public FrequencyUnit Unit { get; }

Property Value

FrequencyUnit

Value

The numeric value this quantity was constructed with.

public double Value { get; }

Property Value

double

Zero

Gets an instance of this quantity with a value of 0 in the base unit Second.

public static Frequency Zero { get; }

Property Value

Frequency

Methods

As(FrequencyUnit)

Convert to the unit representation unit.

public double As(FrequencyUnit unit)

Parameters

unit FrequencyUnit

Returns

double

Value converted to the specified unit.

From(double, FrequencyUnit)

Dynamically convert from value and unit enum FrequencyUnit to Frequency.

public static Frequency From(double value, FrequencyUnit fromUnit)

Parameters

value double

Value to convert from.

fromUnit FrequencyUnit

Unit to convert from.

Returns

Frequency

Frequency unit value.

FromBUnits(double)

Creates a Frequency from BUnit.

public static Frequency FromBUnits(double bunits)

Parameters

bunits double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromBeatsPerMinute(double)

Creates a Frequency from BeatPerMinute.

public static Frequency FromBeatsPerMinute(double beatsperminute)

Parameters

beatsperminute double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromCyclesPerHour(double)

Creates a Frequency from CyclePerHour.

public static Frequency FromCyclesPerHour(double cyclesperhour)

Parameters

cyclesperhour double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromCyclesPerMinute(double)

Creates a Frequency from CyclePerMinute.

public static Frequency FromCyclesPerMinute(double cyclesperminute)

Parameters

cyclesperminute double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromGigahertz(double)

Creates a Frequency from Gigahertz.

public static Frequency FromGigahertz(double gigahertz)

Parameters

gigahertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromHertz(double)

Creates a Frequency from Hertz.

public static Frequency FromHertz(double hertz)

Parameters

hertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromKilohertz(double)

Creates a Frequency from Kilohertz.

public static Frequency FromKilohertz(double kilohertz)

Parameters

kilohertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMegahertz(double)

Creates a Frequency from Megahertz.

public static Frequency FromMegahertz(double megahertz)

Parameters

megahertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMicrohertz(double)

Creates a Frequency from Microhertz.

public static Frequency FromMicrohertz(double microhertz)

Parameters

microhertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMillihertz(double)

Creates a Frequency from Millihertz.

public static Frequency FromMillihertz(double millihertz)

Parameters

millihertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromPerSecond(double)

Creates a Frequency from PerSecond.

public static Frequency FromPerSecond(double persecond)

Parameters

persecond double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromRadiansPerSecond(double)

Creates a Frequency from RadianPerSecond.

public static Frequency FromRadiansPerSecond(double radianspersecond)

Parameters

radianspersecond double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

FromTerahertz(double)

Creates a Frequency from Terahertz.

public static Frequency FromTerahertz(double terahertz)

Parameters

terahertz double

Returns

Frequency

Exceptions

ArgumentException

If value is NaN or Infinity.

ToUnit(FrequencyUnit)

Converts this Frequency to another Frequency with the unit representation unit.

public Frequency ToUnit(FrequencyUnit unit)

Parameters

unit FrequencyUnit

Returns

Frequency

A Frequency with the specified unit.