Skip to main content

Struct Azimuth

Represents a cardinal direction;

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

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

Properties

DecimalDegrees

Gets the cardinal direction value expressed as a unit Decimal Degrees (°)

View Source
Declaration
public double DecimalDegrees { get; }

Radians

Gets the cardinal direction value expressed as Radians

View Source
Declaration
public double Radians { get; }

Compass16PointCardinalName

Gets the cardinal direction value expressed as a unit a 16 division cardinal point name.

View Source
Declaration
public Azimuth16PointCardinalNames Compass16PointCardinalName { get; }

Methods

FromDecimalDegrees(double)

Creates a new Meadow.Units.Azimuth object from a unit value in Decimal Degrees (°).

View Source
Declaration
[Pure]
public static Azimuth FromDecimalDegrees(double degrees)
Returns

Meadow.Units.Azimuth: A new cardinal direction object.

Parameters
TypeNameDescription
System.DoubledegreesThe cardinal direction value.

FromRadians(double)

Creates a new Meadow.Units.Azimuth object from a unit value in Radians.

View Source
Declaration
[Pure]
public static Azimuth FromRadians(double radians)
Returns

Meadow.Units.Azimuth: A new cardinal direction object.

Parameters
TypeNameDescription
System.DoubleradiansThe cardinal direction value.

FromCompass16PointCardinalName(Azimuth16PointCardinalNames)

Creates a new Meadow.Units.Azimuth object

View Source
Declaration
[Pure]
public static Azimuth FromCompass16PointCardinalName(Azimuth16PointCardinalNames name)
Returns

Meadow.Units.Azimuth: A new cardinal direction object.

Parameters
TypeNameDescription
Meadow.Units.Azimuth16PointCardinalNamesnameThe 16 point cardinal direction.

Equals(object)

Compare to another Azimuth object.

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

System.Boolean: true if equal

Parameters
TypeNameDescription
System.Objectobjobject to compare

GetHashCode()

Get hash of object

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

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

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

System.Boolean: true if equal

Parameters
TypeNameDescription
Meadow.Units.AzimuthotherThe object to compare

CompareTo(Azimuth)

Compare to another Azimuth object

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

System.Int32: 0 if equal

Parameters
TypeName
Meadow.Units.Azimuthother

Abs()

Returns the absolute value of the Meadow.Units.Azimuth

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

Meadow.Units.Azimuth

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

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

System.Int32: 0 if equal

Parameters
TypeNameDescription
System.ObjectobjThe other Azimuth 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 convert 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>