Struct Energy
Represents Energy
Assembly: Meadow.Units.dll
View Source
[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
public double BTU { get; }
Calories
Get energy value as calories
View Source
public double Calories { get; }
Joules
Get energy value as joules
View Source
public double Joules { get; }
Kilocalories
Get energy value as kilocalories
View Source
public double Kilocalories { get; }
Kilojoules
Get energy value kilojoules
View Source
public double Kilojoules { get; }
KilowattHours
Get energy value as kilowatt hours
View Source
public double KilowattHours { get; }
Therms
Get energy value as Therms
View Source
public double Therms { get; }
WattHours
Get energy value as watt hours
View Source
public double WattHours { get; }
WattSecond
Get energy value as watt seconds
View Source
public double WattSecond { get; }
Methods
From(UnitType)
Get a double value for a specific unit
View Source
[Pure]
public double From(Energy.UnitType convertTo)
Returns
System.Double: the converted value
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.Units.Energy.UnitType | convertTo | unit to covert to |
Equals(object)
Compare to another Energy object
View Source
[Pure]
public override bool Equals(object obj)
Returns
System.Boolean: true if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Object | obj | The object to compare |
GetHashCode()
Get hash of object
View Source
[Pure]
public override int GetHashCode()
Returns
System.Int32: int32 hash value### Equals(Energy)
Compare to another Energy object
View Source
[Pure]
public bool Equals(Energy other)
Returns
System.Boolean: true if equal
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.Units.Energy | other | The object to compare |
CompareTo(Energy)
Compare to another Energy object
View Source
[Pure]
public int CompareTo(Energy other)
Returns
System.Int32: 0 if equal
Parameters
| Type | Name |
|---|---|
| Meadow.Units.Energy | other |
Abs()
Returns the absolute value of the Meadow.Units.Energy
View Source
[Pure]
public Energy Abs()
Returns
ToString()
Get a string representation of the object
View Source
[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
[Pure]
public string ToString(string format, IFormatProvider formatProvider)
Returns
System.String: A string representing the object
Parameters
| Type | Name | Description |
|---|---|---|
System.String | format | format |
System.IFormatProvider | formatProvider | format provider |
CompareTo(object)
Compare to another Energy object
View Source
[Pure]
public int CompareTo(object obj)
Returns
System.Int32: 0 if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Object | obj | The other Energy cast to object |
GetTypeCode()
Get type code of object
View Source
[Pure]
public TypeCode GetTypeCode()
Returns
System.TypeCode: The TypeCode### ToBoolean(IFormatProvider)
Convert to boolean
View Source
[Pure]
public bool ToBoolean(IFormatProvider provider)
Returns
System.Boolean: bool representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToByte(IFormatProvider)
Convert to byte
View Source
[Pure]
public byte ToByte(IFormatProvider provider)
Returns
System.Byte: byte representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToChar(IFormatProvider)
Convert to char
View Source
[Pure]
public char ToChar(IFormatProvider provider)
Returns
System.Char: char representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToDateTime(IFormatProvider)
Convert to DateTime
View Source
[Pure]
public DateTime ToDateTime(IFormatProvider provider)
Returns
System.DateTime: DateTime representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToDecimal(IFormatProvider)
Convert to Decimal
View Source
[Pure]
public decimal ToDecimal(IFormatProvider provider)
Returns
System.Decimal: Decimal representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToDouble(IFormatProvider)
Convert to double
View Source
[Pure]
public double ToDouble(IFormatProvider provider)
Returns
System.Double: double representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToInt16(IFormatProvider)
Convert to in16
View Source
[Pure]
public short ToInt16(IFormatProvider provider)
Returns
System.Int16: int16 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToInt32(IFormatProvider)
Convert to int32
View Source
[Pure]
public int ToInt32(IFormatProvider provider)
Returns
System.Int32: int32 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToInt64(IFormatProvider)
Convert to int64
View Source
[Pure]
public long ToInt64(IFormatProvider provider)
Returns
System.Int64: int64 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToSByte(IFormatProvider)
Convert to sbyte
View Source
[Pure]
public sbyte ToSByte(IFormatProvider provider)
Returns
System.SByte: sbyte representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToSingle(IFormatProvider)
Convert to float
View Source
[Pure]
public float ToSingle(IFormatProvider provider)
Returns
System.Single: float representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToString(IFormatProvider)
Convert to string
View Source
[Pure]
public string ToString(IFormatProvider provider)
Returns
System.String: string representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToType(Type, IFormatProvider)
Convert to type
View Source
[Pure]
public object ToType(Type conversionType, IFormatProvider provider)
Returns
System.Object: type representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.Type | conversionType | type to covert to |
System.IFormatProvider | provider | format provider |
ToUInt16(IFormatProvider)
Convert to uint16
View Source
[Pure]
public ushort ToUInt16(IFormatProvider provider)
Returns
System.UInt16: uint16 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToUInt32(IFormatProvider)
Convert to uint32
View Source
[Pure]
public uint ToUInt32(IFormatProvider provider)
Returns
System.UInt32: uint32 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
ToUInt64(IFormatProvider)
Convert to uint64
View Source
[Pure]
public ulong ToUInt64(IFormatProvider provider)
Returns
System.UInt64: uint64 representation of the object
Parameters
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | format provider |
CompareTo(double?)
Compare the default value to a double
View Source
[Pure]
public int CompareTo(double? other)
Returns
System.Int32: 0 if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Nullable<System.Double> | other | value to compare |
Equals(double?)
Compare the default value to a double
View Source
[Pure]
public bool Equals(double? other)
Returns
System.Boolean: 0 if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Nullable<System.Double> | other | value to compare |
Equals(double)
Compare the default value to a double
View Source
[Pure]
public bool Equals(double other)
Returns
System.Boolean: 0 if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Double | other | value to compare |
CompareTo(double)
Compare the default value to a double
View Source
[Pure]
public int CompareTo(double other)
Returns
System.Int32: 0 if equal
Parameters
| Type | Name | Description |
|---|---|---|
System.Double | other | value to compare |
Implements
System.IComparableSystem.IFormattableSystem.IConvertibleSystem.IEquatable<System.Double>System.IComparable<System.Double>