Skip to main content

Struct MagneticField3D

Represents a 3-dimensional (X,Y,Z) magnetic field.

Assembly: Meadow.Units.dll
View Source
Declaration
[Serializable]
public struct MagneticField3D : IFormattable, IComparable, IEquatable<(double X, double Y, double Z)>, IComparable<(double, double, double)>

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

Properties

X

X component of the magnetic field

View Source
Declaration
public MagneticField X { readonly get; set; }

Y

Y component of the magnetic field

View Source
Declaration
public MagneticField Y { readonly get; set; }

Z

Z component of the magnetic field

View Source
Declaration
public MagneticField Z { readonly get; set; }

Methods

Equals(object)

Compare to another MagneticField3D object

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

System.Boolean: true if equal

Parameters
TypeNameDescription
System.Objectobjobject to compare to

GetHashCode()

Get hash of object

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

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

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

System.Boolean: true if equal

Parameters
TypeNameDescription
Meadow.Units.MagneticField3DotherThe object to compare

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 MagneticField3D object

View Source
Declaration
public int CompareTo(object obj)
Returns

System.Int32

Parameters
TypeNameDescription
System.ObjectobjThe other MagneticField3D cast to object

Equals((double X, double Y, double Z))

Compare the default value to three doubles

View Source
Declaration
public bool Equals((double X, double Y, double Z) other)
Returns

System.Boolean: true if equal

Parameters
TypeNameDescription
System.ValueTuple<System.Double,System.Double,System.Double>othervalues to compare

CompareTo((double, double, double))

Compare the default value to a tuple of three doubles

View Source
Declaration
public int CompareTo((double, double, double) other)
Returns

System.Int32: 0 if equal

Parameters
TypeNameDescription
System.ValueTuple<System.Double,System.Double,System.Double>othervalue to compare

Implements

  • System.IFormattable
  • System.IComparable
  • System.IEquatable<System.ValueTuple<System.Double,System.Double,System.Double>>
  • System.IComparable<System.ValueTuple<System.Double,System.Double,System.Double>>