Class GeoNearOptionsBuilder

Namespace

MongoDB.Driver.Builders

Assembly

MongoDB.Driver.Legacy.dll

A builder for the options of the GeoNear command.

[Serializable]
[Obsolete("Use GeoNearArgs instead.")]
[BsonSerializer(typeof(GeoNearOptionsBuilder.Serializer))]
public class GeoNearOptionsBuilder : BuilderBase, IConvertibleToBsonDocument, IMongoGeoNearOptions

Inheritance

object

BuilderBase

GeoNearOptionsBuilder

Implements

IConvertibleToBsonDocument

IMongoGeoNearOptions

Inherited Members

BuilderBase.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqToMongo.In<TSource>(TSource, IEnumerable<TSource>)

Constructors

GeoNearOptionsBuilder()

Initializes a new instance of the GeoNearOptionsBuilder class.

public GeoNearOptionsBuilder()

Methods

SetDistanceMultiplier(double)

Sets the distance multiplier.

public GeoNearOptionsBuilder SetDistanceMultiplier(double value)

Parameters

value double

The distance multiplier.

Returns

GeoNearOptionsBuilder

The builder (so method calls can be chained).

SetMaxDistance(double)

Sets the max distance.

public GeoNearOptionsBuilder SetMaxDistance(double value)

Parameters

value double

The max distance.

Returns

GeoNearOptionsBuilder

The builder (so method calls can be chained).

SetSpherical(bool)

Sets whether to use a spherical search.

public GeoNearOptionsBuilder SetSpherical(bool value)

Parameters

value bool

Whether to use a spherical search.

Returns

GeoNearOptionsBuilder

The builder (so method calls can be chained).

ToBsonDocument()

Returns the result of the builder as a BsonDocument.

public override BsonDocument ToBsonDocument()

Returns

BsonDocument

A BsonDocument.