Struct ElectricPotential

Namespace

UnitsNet

Assembly

UnitsNet.ElectricPotential.dll

In classical electromagnetism, the electric potential (a scalar quantity denoted by Φ, ΦE or V and also called the electric field potential or the electrostatic potential) at a point is the amount of electric potential energy that a unitary point charge would have when located at that point.

public struct ElectricPotential

Remarks

If you want to map more parameters into the ElectricPotential class (volts RMS, phase angle, etc.), create your own wrapper type such as a record or named tuple.

Constructors

ElectricPotential(double, ElectricPotentialUnit)

Creates the quantity with the given numeric value and unit.

public ElectricPotential(double value, ElectricPotentialUnit unit)

Parameters

value double

The numeric value to construct this quantity with.

unit ElectricPotentialUnit

The unit representation to construct this quantity with.

Exceptions

ArgumentException

If value is NaN or Infinity.

Properties

BaseUnit

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

public static ElectricPotentialUnit BaseUnit { get; }

Property Value

ElectricPotentialUnit

Kilovolts

Gets a double value of this quantity converted into Kilovolt

public double Kilovolts { get; }

Property Value

double

MaxValue

Represents the largest possible value of ElectricPotential.

public static ElectricPotential MaxValue { get; }

Property Value

ElectricPotential

Megavolts

Gets a double value of this quantity converted into Megavolt

public double Megavolts { get; }

Property Value

double

Microvolts

Gets a double value of this quantity converted into Microvolt

public double Microvolts { get; }

Property Value

double

Millivolts

Gets a double value of this quantity converted into Millivolt

public double Millivolts { get; }

Property Value

double

MinValue

Represents the smallest possible value of ElectricPotential.

public static ElectricPotential MinValue { get; }

Property Value

ElectricPotential

Nanovolts

Gets a double value of this quantity converted into Nanovolt

public double Nanovolts { get; }

Property Value

double

Unit

public ElectricPotentialUnit Unit { get; }

Property Value

ElectricPotentialUnit

Value

The numeric value this quantity was constructed with.

public double Value { get; }

Property Value

double

Volts

Gets a double value of this quantity converted into Volt

public double Volts { get; }

Property Value

double

Zero

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

public static ElectricPotential Zero { get; }

Property Value

ElectricPotential

Methods

As(ElectricPotentialUnit)

Convert to the unit representation unit.

public double As(ElectricPotentialUnit unit)

Parameters

unit ElectricPotentialUnit

Returns

double

Value converted to the specified unit.

From(double, ElectricPotentialUnit)

Dynamically convert from value and unit enum ElectricPotentialUnit to ElectricPotential.

public static ElectricPotential From(double value, ElectricPotentialUnit fromUnit)

Parameters

value double

Value to convert from.

fromUnit ElectricPotentialUnit

Unit to convert from.

Returns

ElectricPotential

ElectricPotential unit value.

FromKilovolts(double)

Creates a ElectricPotential from Kilovolt.

public static ElectricPotential FromKilovolts(double kilovolts)

Parameters

kilovolts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMegavolts(double)

Creates a ElectricPotential from Megavolt.

public static ElectricPotential FromMegavolts(double megavolts)

Parameters

megavolts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMicrovolts(double)

Creates a ElectricPotential from Microvolt.

public static ElectricPotential FromMicrovolts(double microvolts)

Parameters

microvolts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

FromMillivolts(double)

Creates a ElectricPotential from Millivolt.

public static ElectricPotential FromMillivolts(double millivolts)

Parameters

millivolts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

FromNanovolts(double)

Creates a ElectricPotential from Nanovolt.

public static ElectricPotential FromNanovolts(double nanovolts)

Parameters

nanovolts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

FromVolts(double)

Creates a ElectricPotential from Volt.

public static ElectricPotential FromVolts(double volts)

Parameters

volts double

Returns

ElectricPotential

Exceptions

ArgumentException

If value is NaN or Infinity.

ToUnit(ElectricPotentialUnit)

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

public ElectricPotential ToUnit(ElectricPotentialUnit unit)

Parameters

unit ElectricPotentialUnit

Returns

ElectricPotential

A ElectricPotential with the specified unit.