Show / Hide Table of Contents

Struct Distance

Represents length distance with unit type. All operations are done with presision of 1 micrometer (10^(-3) mm)

Implements
System.IEquatable<Distance>
System.IComparable<Distance>
IJSONWritable
System.IFormattable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: NFX.Standards
Assembly: NFX.dll
Syntax
public struct Distance : IEquatable<Distance>, IComparable<Distance>, IJSONWritable, IFormattable

Constructors

Distance(Decimal, Distance.UnitType)

Declaration
public Distance(decimal value, Distance.UnitType unit)
Parameters
Type Name Description
System.Decimal value
Distance.UnitType unit

Fields

MM_IN_CM

Declaration
public const decimal MM_IN_CM = 10.0M
Field Value
Type Description
System.Decimal

MM_IN_FT

Declaration
public const decimal MM_IN_FT = 304.8M
Field Value
Type Description
System.Decimal

MM_IN_IN

Declaration
public const decimal MM_IN_IN = 25.4M
Field Value
Type Description
System.Decimal

MM_IN_M

Declaration
public const decimal MM_IN_M = 1000.0M
Field Value
Type Description
System.Decimal

MM_IN_YD

Declaration
public const decimal MM_IN_YD = 914.4M
Field Value
Type Description
System.Decimal

Unit

Declaration
public readonly Distance.UnitType Unit
Field Value
Type Description
Distance.UnitType

Value

Declaration
public readonly decimal Value
Field Value
Type Description
System.Decimal

VALUE_PRECISION

Declaration
public const int VALUE_PRECISION = 3
Field Value
Type Description
System.Int32

ValueInMm

Declaration
public readonly decimal ValueInMm
Field Value
Type Description
System.Decimal

Properties

UnitName

Declaration
public string UnitName { get; }
Property Value
Type Description
System.String

Methods

CompareTo(Distance)

Declaration
public int CompareTo(Distance other)
Parameters
Type Name Description
Distance other
Returns
Type Description
System.Int32

Convert(Distance.UnitType)

Declaration
public Distance Convert(Distance.UnitType toUnit)
Parameters
Type Name Description
Distance.UnitType toUnit
Returns
Type Description
Distance

Equals(Distance)

Declaration
public bool Equals(Distance other)
Parameters
Type Name Description
Distance other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()

Parse(String)

Declaration
public static Distance Parse(string val)
Parameters
Type Name Description
System.String val
Returns
Type Description
Distance

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()

ToString(String, IFormatProvider)

Declaration
public string ToString(string format, IFormatProvider formatProvider)
Parameters
Type Name Description
System.String format
System.IFormatProvider formatProvider
Returns
Type Description
System.String

TryParse(String, out Nullable<Distance>)

Declaration
public static bool TryParse(string val, out Distance? result)
Parameters
Type Name Description
System.String val
System.Nullable<Distance> result
Returns
Type Description
System.Boolean

ValueIn(Distance.UnitType)

Declaration
public decimal ValueIn(Distance.UnitType toUnit)
Parameters
Type Name Description
Distance.UnitType toUnit
Returns
Type Description
System.Decimal

WriteAsJSON(TextWriter, Int32, JSONWritingOptions)

Declaration
public void WriteAsJSON(TextWriter wri, int nestingLevel, JSONWritingOptions options = null)
Parameters
Type Name Description
System.IO.TextWriter wri
System.Int32 nestingLevel
JSONWritingOptions options

Operators

Addition(Distance, Distance)

Declaration
public static Distance operator +(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
Distance

Division(Distance, Decimal)

Declaration
public static Distance operator /(Distance obj1, decimal obj2)
Parameters
Type Name Description
Distance obj1
System.Decimal obj2
Returns
Type Description
Distance

Equality(Distance, Distance)

Declaration
public static bool operator ==(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

GreaterThan(Distance, Distance)

Declaration
public static bool operator>(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

GreaterThanOrEqual(Distance, Distance)

Declaration
public static bool operator >=(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

Inequality(Distance, Distance)

Declaration
public static bool operator !=(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

LessThan(Distance, Distance)

Declaration
public static bool operator <(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

LessThanOrEqual(Distance, Distance)

Declaration
public static bool operator <=(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
System.Boolean

Multiply(Distance, Decimal)

Declaration
public static Distance operator *(Distance obj1, decimal obj2)
Parameters
Type Name Description
Distance obj1
System.Decimal obj2
Returns
Type Description
Distance

Subtraction(Distance, Distance)

Declaration
public static Distance operator -(Distance obj1, Distance obj2)
Parameters
Type Name Description
Distance obj1
Distance obj2
Returns
Type Description
Distance

Implements

System.IEquatable<T>
System.IComparable<T>
IJSONWritable
System.IFormattable

Extension Methods

ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX