/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents.Spatial/Position.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
343 lines (343 sloc) 15.9 KB
<Type Name="Position" FullName="Microsoft.Azure.Documents.Spatial.Position">
<TypeSignature Language="C#" Value="public sealed class Position : IEquatable&lt;Microsoft.Azure.Documents.Spatial.Position&gt;" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Position extends System.Object implements class System.IEquatable`1&lt;class Microsoft.Azure.Documents.Spatial.Position&gt;" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Spatial.Position" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable&lt;Microsoft.Azure.Documents.Spatial.Position&gt;</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.Spatial.Converters.PositionJsonConverter))</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
<para>
A position is represented by an array of numbers in the Azure DocumentDB database service. There must be at least two elements, and may be more.
</para>
<para>
The order of elements must follow longitude, latitude, altitude.
Any number of additional elements are allowed - interpretation and meaning of additional elements is up to the application.
</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Position (System.Collections.Generic.IList&lt;double&gt; coordinates);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1&lt;float64&gt; coordinates) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.#ctor(System.Collections.Generic.IList{System.Double})" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="coordinates" Type="System.Collections.Generic.IList&lt;System.Double&gt;" />
</Parameters>
<Docs>
<param name="coordinates">
Position values.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> class in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Position (double longitude, double latitude);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 longitude, float64 latitude) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.#ctor(System.Double,System.Double)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="longitude" Type="System.Double" />
<Parameter Name="latitude" Type="System.Double" />
</Parameters>
<Docs>
<param name="longitude">
Longitude value.
</param>
<param name="latitude">
Latitude value.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> class in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Position (double longitude, double latitude, Nullable&lt;double&gt; altitude);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 longitude, float64 latitude, valuetype System.Nullable`1&lt;float64&gt; altitude) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.#ctor(System.Double,System.Double,System.Nullable{System.Double})" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="longitude" Type="System.Double" />
<Parameter Name="latitude" Type="System.Double" />
<Parameter Name="altitude" Type="System.Nullable&lt;System.Double&gt;" />
</Parameters>
<Docs>
<param name="longitude">
Longitude value.
</param>
<param name="latitude">
Latitude value.
</param>
<param name="altitude">
Optional altitude value.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> class in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Altitude">
<MemberSignature Language="C#" Value="public Nullable&lt;double&gt; Altitude { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;float64&gt; Altitude" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Spatial.Position.Altitude" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable&lt;System.Double&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets optional altitude in the Azure DocumentDB database service.
</summary>
<value>
Altitude value.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Coordinates">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection&lt;double&gt; Coordinates { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1&lt;float64&gt; Coordinates" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Spatial.Position.Coordinates" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection&lt;System.Double&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets position coordinates in the Azure DocumentDB database service.
</summary>
<value>
Coordinate values.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.Azure.Documents.Spatial.Position other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.Azure.Documents.Spatial.Position other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.Equals(Microsoft.Azure.Documents.Spatial.Position)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Documents.Spatial.Position" />
</Parameters>
<Docs>
<param name="other">
<see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> to compare to this <see cref="T:Microsoft.Azure.Documents.Spatial.Position" />.</param>
<summary>
Determines if this <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> is equal to the <paramref name="other" /> in the Azure DocumentDB database service.
</summary>
<returns>
<c>true</c> if objects are equal. <c>false</c> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.Equals(System.Object)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> to compare to the current object. </param>
<summary>
Determines whether the specified <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> is equal to the current <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> in the Azure DocumentDB database service.
</summary>
<returns>
true if the specified <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> is equal to the current object; otherwise, false.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Spatial.Position.GetHashCode" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Serves as a hash function for the <see cref="T:Microsoft.Azure.Documents.Spatial.Position" /> type in the Azure DocumentDB database service.
</summary>
<returns>
A hash code for the current <see cref="T:Microsoft.Azure.Documents.Spatial.Position" />.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Latitude">
<MemberSignature Language="C#" Value="public double Latitude { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Latitude" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Spatial.Position.Latitude" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets latitude in the Azure DocumentDB database service.
</summary>
<value>
Latitude value.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Longitude">
<MemberSignature Language="C#" Value="public double Longitude { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Longitude" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Spatial.Position.Longitude" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets longitude in the Azure DocumentDB database service.
</summary>
<value>
Longitude value.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>