Skip to main content

Struct Energy

Represents Energy

Assembly: Meadow.Units.dll
View Source
Declaration
[Serializable]
public struct Energy : IComparable, IFormattable, IConvertible, IEquatable<double>, IComparable<double>

Implements:
System.IComparable, System.IFormattable, System.IConvertible, System.IEquatable<System.Double>, System.IComparable<System.Double>

Properties

BTU

Get energy value as BTUs

View Source
Declaration
public double BTU { get; }

Calories

Get energy value as calories

View Source
Declaration
public double Calories { get; }

Joules

Get energy value as joules

View Source
Declaration
public double Joules { get; }

Kilocalories

Get energy value as kilocalories

View Source
Declaration
public double Kilocalories { get; }

Kilojoules

Get energy value kilojoules

View Source
Declaration
public double Kilojoules { get; }

KilowattHours

Get energy value as kilowatt hours

View Source
Declaration
public double KilowattHours { get; }

Therms

Get energy value as Therms

View Source
Declaration
public double Therms { get; }

WattHours

Get energy value as watt hours

View Source
Declaration
public double WattHours { get; }

WattSecond

Get energy value as watt seconds

View Source
Declaration
public double WattSecond { get; }

Methods

From(UnitType)

Get a double value for a specific unit

View Source
Declaration
[Pure]
public double From(Energy.UnitType convertTo)
Returns

System.Double: the converted value

Parameters
TypeNameDescription
Meadow.Units.Energy.UnitTypeconvertTounit to covert to

Equals(object)

Compare to another Energy object

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

System.Boolean: true if equal

Parameters
TypeNameDescription
System.ObjectobjThe object to compare

GetHashCode()

Get hash of object

View Source
Declaration
[Pure]
public override int GetHashCode()
Returns

System.Int32: int32 hash value### Equals(Energy) Compare to another Energy object

View Source
Declaration
[Pure]
public bool Equals(Energy other)
Returns

System.Boolean: true if equal

Parameters
TypeNameDescription
Meadow.Units.EnergyotherThe object to compare

CompareTo(Energy)

Compare to another Energy object

View Source
Declaration
[Pure]
public int CompareTo(Energy other)
Returns

System.Int32: 0 if equal

Parameters
TypeName
Meadow.Units.Energyother

Abs()

Returns the absolute value of the Meadow.Units.Energy

View Source
Declaration
[Pure]
public Energy Abs()
Returns

Meadow.Units.Energy

ToString()

Get a string representation of the object

View Source
Declaration
[Pure]
public override string ToString()
Returns

System.String: A string representing the object### ToString(string, IFormatProvider) Get a string representation of the object

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

System.String: A string representing the object

Parameters
TypeNameDescription
System.Stringformatformat
System.IFormatProviderformatProviderformat provider

CompareTo(object)

Compare to another Energy object

View Source
Declaration
[Pure]
public int CompareTo(object obj)
Returns

System.Int32: 0 if equal

Parameters
TypeNameDescription
System.ObjectobjThe other Energy cast to object

GetTypeCode()

Get type code of object

View Source
Declaration
[Pure]
public TypeCode GetTypeCode()
Returns

System.TypeCode: The TypeCode### ToBoolean(IFormatProvider) Convert to boolean

View Source
Declaration
[Pure]
public bool ToBoolean(IFormatProvider provider)
Returns

System.Boolean: bool representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToByte(IFormatProvider)

Convert to byte

View Source
Declaration
[Pure]
public byte ToByte(IFormatProvider provider)
Returns

System.Byte: byte representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToChar(IFormatProvider)

Convert to char

View Source
Declaration
[Pure]
public char ToChar(IFormatProvider provider)
Returns

System.Char: char representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToDateTime(IFormatProvider)

Convert to DateTime

View Source
Declaration
[Pure]
public DateTime ToDateTime(IFormatProvider provider)
Returns

System.DateTime: DateTime representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToDecimal(IFormatProvider)

Convert to Decimal

View Source
Declaration
[Pure]
public decimal ToDecimal(IFormatProvider provider)
Returns

System.Decimal: Decimal representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToDouble(IFormatProvider)

Convert to double

View Source
Declaration
[Pure]
public double ToDouble(IFormatProvider provider)
Returns

System.Double: double representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToInt16(IFormatProvider)

Convert to in16

View Source
Declaration
[Pure]
public short ToInt16(IFormatProvider provider)
Returns

System.Int16: int16 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToInt32(IFormatProvider)

Convert to int32

View Source
Declaration
[Pure]
public int ToInt32(IFormatProvider provider)
Returns

System.Int32: int32 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToInt64(IFormatProvider)

Convert to int64

View Source
Declaration
[Pure]
public long ToInt64(IFormatProvider provider)
Returns

System.Int64: int64 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToSByte(IFormatProvider)

Convert to sbyte

View Source
Declaration
[Pure]
public sbyte ToSByte(IFormatProvider provider)
Returns

System.SByte: sbyte representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToSingle(IFormatProvider)

Convert to float

View Source
Declaration
[Pure]
public float ToSingle(IFormatProvider provider)
Returns

System.Single: float representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToString(IFormatProvider)

Convert to string

View Source
Declaration
[Pure]
public string ToString(IFormatProvider provider)
Returns

System.String: string representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToType(Type, IFormatProvider)

Convert to type

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

System.Object: type representation of the object

Parameters
TypeNameDescription
System.TypeconversionTypetype to covert to
System.IFormatProviderproviderformat provider

ToUInt16(IFormatProvider)

Convert to uint16

View Source
Declaration
[Pure]
public ushort ToUInt16(IFormatProvider provider)
Returns

System.UInt16: uint16 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToUInt32(IFormatProvider)

Convert to uint32

View Source
Declaration
[Pure]
public uint ToUInt32(IFormatProvider provider)
Returns

System.UInt32: uint32 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

ToUInt64(IFormatProvider)

Convert to uint64

View Source
Declaration
[Pure]
public ulong ToUInt64(IFormatProvider provider)
Returns

System.UInt64: uint64 representation of the object

Parameters
TypeNameDescription
System.IFormatProviderproviderformat provider

CompareTo(double?)

Compare the default value to a double

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

System.Int32: 0 if equal

Parameters
TypeNameDescription
System.Nullable<System.Double>othervalue to compare

Equals(double?)

Compare the default value to a double

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

System.Boolean: 0 if equal

Parameters
TypeNameDescription
System.Nullable<System.Double>othervalue to compare

Equals(double)

Compare the default value to a double

View Source
Declaration
[Pure]
public bool Equals(double other)
Returns

System.Boolean: 0 if equal

Parameters
TypeNameDescription
System.Doubleothervalue to compare

CompareTo(double)

Compare the default value to a double

View Source
Declaration
[Pure]
public int CompareTo(double other)
Returns

System.Int32: 0 if equal

Parameters
TypeNameDescription
System.Doubleothervalue to compare

Implements

  • System.IComparable
  • System.IFormattable
  • System.IConvertible
  • System.IEquatable<System.Double>
  • System.IComparable<System.Double>