Characteristic Locus
Implements IComparable IFormattable IConvertible IEquatable<double> IComparable<double>
Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object)
Namespace Meadow.Units
Assembly Meadow.Units.dll

Syntax

[Serializable]
public struct Illuminance : IComparable, IFormattable, IConvertible, IEquatable<double>, IComparable<double>

Constructors

Illuminance(Illuminance)

Creates a new Illuminance object from an existing Illuminance object

Declaration
public Illuminance(Illuminance illuminance)

Parameters

Type Name Description
Illuminance illuminance

Illuminance(double, UnitType)

Creates a new Illuminance object.

Declaration
public Illuminance(double value, Illuminance.UnitType type = UnitType.Lux)

Parameters

Type Name Description
double value

The Illuminance value.

Illuminance.UnitType type

kilometers meters per second by default.

Properties

FootCandles

Get illuminance value as foot candles

Declaration
public double FootCandles { get; }

Property Value

Type Description
double

KiloLux

Get illuminance value as kiloLux

Declaration
public double KiloLux { get; }

Property Value

Type Description
double

Lux

Get illuminance value as Lux

Declaration
public double Lux { get; }

Property Value

Type Description
double

Methods

Abs()

Returns the absolute value of the Illuminance

Declaration
[Pure]
public Illuminance Abs()

Returns

Type Description
Illuminance

CompareTo(Illuminance)

Compare to another Illuminance object

Declaration
[Pure]
public int CompareTo(Illuminance other)

Parameters

Type Name Description
Illuminance other

Returns

Type Description
int

0 if equal

CompareTo(double)

Compare the default value to a double

Declaration
[Pure]
public int CompareTo(double other)

Parameters

Type Name Description
double other

value to compare

Returns

Type Description
int

0 if equal

CompareTo(double?)

Compare the default value to a double

Declaration
[Pure]
public int CompareTo(double? other)

Parameters

Type Name Description
double? other

value to compare

Returns

Type Description
int

0 if equal

CompareTo(object)

Compare to another AbsoluteHumidity object

Declaration
[Pure]
public int CompareTo(object obj)

Parameters

Type Name Description
object obj

The other AbsoluteHumity cast to object

Returns

Type Description
int

0 if equal

Equals(Illuminance)

Compare to another Illuminance object

Declaration
[Pure]
public bool Equals(Illuminance other)

Parameters

Type Name Description
Illuminance other

The object to compare

Returns

Type Description
bool

true if equal

Equals(double)

Compare the default value to a double

Declaration
[Pure]
public bool Equals(double other)

Parameters

Type Name Description
double other

value to compare

Returns

Type Description
bool

0 if equal

Equals(double?)

Compare the default value to a double

Declaration
[Pure]
public bool Equals(double? other)

Parameters

Type Name Description
double? other

value to compare

Returns

Type Description
bool

0 if equal

Equals(object)

Compare to another Illuminance object

Declaration
[Pure]
public override bool Equals(object obj)

Parameters

Type Name Description
object obj

The object to compare

Returns

Type Description
bool

true if equal

Overrides

From(UnitType)

Get illuminance value for a given unit

Declaration
[Pure]
public double From(Illuminance.UnitType convertTo)

Parameters

Type Name Description
Illuminance.UnitType convertTo

unit to convert to

Returns

Type Description
double

GetHashCode()

Get hash of object

Declaration
[Pure]
public override int GetHashCode()

Returns

Type Description
int

int32 hash value

Overrides

GetTypeCode()

Get type code of object

Declaration
[Pure]
public TypeCode GetTypeCode()

Returns

Type Description
TypeCode

The TypeCode

ToBoolean(IFormatProvider)

Convert to boolean

Declaration
[Pure]
public bool ToBoolean(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
bool

bool representation of the object

ToByte(IFormatProvider)

Convert to byte

Declaration
[Pure]
public byte ToByte(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
byte

byte representation of the object

ToChar(IFormatProvider)

Convert to char

Declaration
[Pure]
public char ToChar(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
char

char representation of the object

ToDateTime(IFormatProvider)

Convert to DateTime

Declaration
[Pure]
public DateTime ToDateTime(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
DateTime

DateTime representation of the object

ToDecimal(IFormatProvider)

Convert to Decimal

Declaration
[Pure]
public decimal ToDecimal(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
decimal

Decimal representation of the object

ToDouble(IFormatProvider)

Convert to double

Declaration
[Pure]
public double ToDouble(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
double

double representation of the object

ToInt16(IFormatProvider)

Convert to in16

Declaration
[Pure]
public short ToInt16(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
short

int16 representation of the object

ToInt32(IFormatProvider)

Convert to int32

Declaration
[Pure]
public int ToInt32(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
int

int32 representation of the object

ToInt64(IFormatProvider)

Convert to int64

Declaration
[Pure]
public long ToInt64(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
long

int64 representation of the object

ToSByte(IFormatProvider)

Convert to sbyte

Declaration
[Pure]
public sbyte ToSByte(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
sbyte

sbyte representation of the object

ToSingle(IFormatProvider)

Convert to float

Declaration
[Pure]
public float ToSingle(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
float

float representation of the object

ToString()

Get a string representation of the object

Declaration
[Pure]
public override string ToString()

Returns

Type Description
string

A string representing the object

Overrides

ToString(IFormatProvider)

Convert to string

Declaration
[Pure]
public string ToString(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
string

string representation of the object

ToString(string, IFormatProvider)

Get a string representation of the object

Declaration
[Pure]
public string ToString(string format, IFormatProvider formatProvider)

Parameters

Type Name Description
string format

format

IFormatProvider formatProvider

format provider

Returns

Type Description
string

A string representing the object

ToType(Type, IFormatProvider)

Convert to type

Declaration
[Pure]
public object ToType(Type conversionType, IFormatProvider provider)

Parameters

Type Name Description
Type conversionType

type to convert to

IFormatProvider provider

format provider

Returns

Type Description
object

type representation of the object

ToUInt16(IFormatProvider)

Convert to uint16

Declaration
[Pure]
public ushort ToUInt16(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
ushort

uint16 representation of the object

ToUInt32(IFormatProvider)

Convert to uint32

Declaration
[Pure]
public uint ToUInt32(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
uint

uint32 representation of the object

ToUInt64(IFormatProvider)

Convert to uint64

Declaration
[Pure]
public ulong ToUInt64(IFormatProvider provider)

Parameters

Type Name Description
IFormatProvider provider

format provider

Returns

Type Description
ulong

uint64 representation of the object

Operators

operator +(Illuminance, Illuminance)

Addition operator to add two Illuminance objects

Declaration
[Pure]
public static Illuminance operator +(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
Illuminance

A new Illuminance object with a value of left + right

operator /(Illuminance, double)

Division operator to divide by a double

Declaration
[Pure]
public static Illuminance operator /(Illuminance value, double operand)

Parameters

Type Name Description
Illuminance value

object to be divided

double operand

operand to divide object

Returns

Type Description
Illuminance

A new Illuminance object with a value of value divided by the operand

operator ==(Illuminance, Illuminance)

Equals operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator ==(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if equal

operator >(Illuminance, Illuminance)

Greater than operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator >(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if left is greater than right

operator >=(Illuminance, Illuminance)

Greater than or equal operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator >=(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if left is greater than or equal to right

operator !=(Illuminance, Illuminance)

Not equals operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator !=(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if not equal

operator <(Illuminance, Illuminance)

Less than operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator <(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if left is less than right

operator <=(Illuminance, Illuminance)

Less than or equal operator to compare two Illuminance objects

Declaration
[Pure]
public static bool operator <=(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
bool

true if left is less than or equal to right

operator *(Illuminance, double)

Multiplication operator to multiply by a double

Declaration
[Pure]
public static Illuminance operator *(Illuminance value, double operand)

Parameters

Type Name Description
Illuminance value

object to multiply

double operand

operand to multiply object

Returns

Type Description
Illuminance

A new Illuminance object with a value of value multiplied by the operand

operator -(Illuminance, Illuminance)

Subtraction operator to subtract two Illuminance objects

Declaration
[Pure]
public static Illuminance operator -(Illuminance left, Illuminance right)

Parameters

Type Name Description
Illuminance left

left value

Illuminance right

right value

Returns

Type Description
Illuminance

A new Illuminance object with a value of left - right