Struct Illuminance
- Namespace
- UnitsNet
- Assembly
- UnitsNet.Illuminance.dll
In photometry, illuminance is the total luminous flux incident on a surface, per unit area.
public struct Illuminance
Remarks
Constructors
Illuminance(double, IlluminanceUnit)
Creates the quantity with the given numeric value and unit.
public Illuminance(double value, IlluminanceUnit unit)
Parameters
value
doubleThe numeric value to construct this quantity with.
unit
IlluminanceUnitThe unit representation to construct this quantity with.
Exceptions
- ArgumentException
If value is NaN or Infinity.
Properties
BaseUnit
The base unit of Illuminance, which is Second. All conversions go via this value.
public static IlluminanceUnit BaseUnit { get; }
Property Value
Kilolux
public double Kilolux { get; }
Property Value
Lux
public double Lux { get; }
Property Value
MaxValue
Represents the largest possible value of Illuminance.
public static Illuminance MaxValue { get; }
Property Value
Megalux
public double Megalux { get; }
Property Value
Millilux
public double Millilux { get; }
Property Value
MinValue
Represents the smallest possible value of Illuminance.
public static Illuminance MinValue { get; }
Property Value
Unit
public IlluminanceUnit Unit { get; }
Property Value
Value
The numeric value this quantity was constructed with.
public double Value { get; }
Property Value
Zero
Gets an instance of this quantity with a value of 0 in the base unit Second.
public static Illuminance Zero { get; }
Property Value
Methods
As(IlluminanceUnit)
Convert to the unit representation unit
.
public double As(IlluminanceUnit unit)
Parameters
unit
IlluminanceUnit
Returns
- double
Value converted to the specified unit.
From(double, IlluminanceUnit)
Dynamically convert from value and unit enum IlluminanceUnit to Illuminance.
public static Illuminance From(double value, IlluminanceUnit fromUnit)
Parameters
value
doubleValue to convert from.
fromUnit
IlluminanceUnitUnit to convert from.
Returns
- Illuminance
Illuminance unit value.
FromKilolux(double)
Creates a Illuminance from Kilolux.
public static Illuminance FromKilolux(double kilolux)
Parameters
kilolux
double
Returns
Exceptions
- ArgumentException
If value is NaN or Infinity.
FromLux(double)
Creates a Illuminance from Lux.
public static Illuminance FromLux(double lux)
Parameters
lux
double
Returns
Exceptions
- ArgumentException
If value is NaN or Infinity.
FromMegalux(double)
Creates a Illuminance from Megalux.
public static Illuminance FromMegalux(double megalux)
Parameters
megalux
double
Returns
Exceptions
- ArgumentException
If value is NaN or Infinity.
FromMillilux(double)
Creates a Illuminance from Millilux.
public static Illuminance FromMillilux(double millilux)
Parameters
millilux
double
Returns
Exceptions
- ArgumentException
If value is NaN or Infinity.
ToUnit(IlluminanceUnit)
Converts this Illuminance to another Illuminance with the unit representation unit
.
public Illuminance ToUnit(IlluminanceUnit unit)
Parameters
unit
IlluminanceUnit
Returns
- Illuminance
A Illuminance with the specified unit.