Charge Structure

Represents an electric charge measurement, in coulombs (i.e., ampere-seconds), as a double-precision floating-point number.

Inheritance Hierarchy

SystemObject
SystemValueType
GSF.UnitsCharge

Namespace: GSF.Units
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public struct Charge : IComparable, IFormattable, 
	IConvertible, IComparable<Charge>, IComparable<double>, IEquatable<Charge>, 
	IEquatable<double>

<SerializableAttribute>
Public Structure Charge
	Implements IComparable, IFormattable, IConvertible, IComparable(Of Charge), 
	IComparable(Of Double), IEquatable(Of Charge), IEquatable(Of Double)

[SerializableAttribute]
public value class Charge : IComparable, 
	IFormattable, IConvertible, IComparable<Charge>, IComparable<double>, 
	IEquatable<Charge>, IEquatable<double>

[<SealedAttribute>]
[<SerializableAttribute>]
type Charge = 
    struct
        inherit ValueType
        interface IComparable
        interface IFormattable
        interface IConvertible
        interface IComparable<Charge>
        interface IComparable<float>
        interface IEquatable<Charge>
        interface IEquatable<float>
    end

JavaScript supports the use of structures, but not the declaration of new ones.

View Source

The Charge type exposes the following members.

Constructors

	Name	Description
	Charge	Creates a new Charge.

Top

Methods

	Name	Description
	CompareTo(Charge)	Compares this instance to a specified Charge and returns an indication of their relative values.
	CompareTo(Double)	Compares this instance to a specified Double and returns an indication of their relative values.
	CompareTo(Object)	Compares this instance to a specified object and returns an indication of their relative values.
	ConvertFrom	Converts the value in the specified sourceUnit to a new Charge in coulombs.
	ConvertTo	Converts the Charge to the specified targetUnit.
	Equals(Charge)	Returns a value indicating whether this instance is equal to a specified Charge value.
	Equals(Double)	Returns a value indicating whether this instance is equal to a specified Double value.
	Equals(Object)	Returns a value indicating whether this instance is equal to a specified object. (Overrides ValueTypeEquals(Object))
	FromAbcoulombs	Creates a new Charge value from the specified value in abcoulombs.
	FromAmpereHours	Creates a new Charge value from the specified value in ampere-hours.
	FromAtomicUnitsOfCharge	Creates a new Charge value from the specified value in atomic units of charge.
	FromFaraday	Creates a new Charge value from the specified value in faraday.
	FromStatcoulombs	Creates a new Charge value from the specified value in statcoulombs.
	GetHashCode	Returns the hash code for this instance. (Overrides ValueTypeGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetTypeCode	Returns the TypeCode for value type Double.
	Parse(String)	Converts the string representation of a number to its Charge equivalent.
	Parse(String, NumberStyles)	Converts the string representation of a number in a specified style to its Charge equivalent.
	Parse(String, IFormatProvider)	Converts the string representation of a number in a specified culture-specific format to its Charge equivalent.
	Parse(String, NumberStyles, IFormatProvider)	Converts the string representation of a number in a specified style and culture-specific format to its Charge equivalent.
	ToAbcoulombs	Gets the Charge value in abcoulombs.
	ToAmpereHours	Gets the Energy value in ampere-hours.
	ToAtomicUnitsOfCharge	Gets the Charge value in atomic units of charge.
	ToFaraday	Gets the Charge value in faraday.
	ToStatcoulombs	Gets the Charge value in statcoulombs.
	ToString	Converts the numeric value of this instance to its equivalent string representation. (Overrides ValueTypeToString)
	ToString(IFormatProvider)	Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
	ToString(String)	Converts the numeric value of this instance to its equivalent string representation, using the specified format.
	ToString(String, IFormatProvider)	Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.
	TryParse(String, Charge)	Converts the string representation of a number to its Charge equivalent. A return value indicates whether the conversion succeeded or failed.
	TryParse(String, NumberStyles, IFormatProvider, Charge)	Converts the string representation of a number in a specified style and culture-specific format to its Charge equivalent. A return value indicates whether the conversion succeeded or failed.

Top

Operators

	Name	Description
	Addition(Charge, Charge)	Returns computed sum of values.
	Division(Charge, Charge)	Returns computed division of values.
	Equality(Charge, Charge)	Compares the two values for equality.
	Exponent(Charge, Charge)	Returns result of first value raised to charge of second value.
	GreaterThan(Charge, Charge)	Returns true if left value is greater than right value.
	GreaterThanOrEqual(Charge, Charge)	Returns true if left value is greater than or equal to right value.
	(Charge to Double)	Implicitly converts Charge, represented in coulombs, to a Double.
	(Double to Charge)	Implicitly converts value, represented in coulombs, to a Charge.
	Inequality(Charge, Charge)	Compares the two values for inequality.
	LessThan(Charge, Charge)	Returns true if left value is less than right value.
	LessThanOrEqual(Charge, Charge)	Returns true if left value is less or equal to than right value.
	Modulus(Charge, Charge)	Returns computed remainder after dividing first value by the second.
	Multiply(Charge, Charge)	Returns computed product of values.
	Subtraction(Charge, Charge)	Returns computed difference of values.

Top

Fields

	Name	Description
	MaxValue	Represents the largest possible value of an Charge. This field is constant.
	MinValue	Represents the smallest possible value of an Charge. This field is constant.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

This class behaves just like a Double representing a charge in coulombs; it is implicitly castable to and from a Double and therefore can be generally used "as" a double, but it has the advantage of handling conversions to and from other charge representations, specifically ampere-hours, abcoulomb (a.k.a., an electromagnetic unit), statcoulomb (a.k.a., electrostatic unit or franklin), atomic unit of charge and faraday. Metric conversions are handled simply by applying the needed SI conversion factor, for example:

Example

Convert charge, in coulombs, to kilocoulombs:

Copy

public double GetKilocoulombs(Charge coulombs)
{
    return coulombs / SI.Kilo;
}

Reference

GSF.Units Namespace