Class GeoBoundingBox

Namespace

Trellis.Primitives

Assembly

Trellis.Primitives.dll

One non-wrapping latitude/longitude rectangle used as a conservative geographic query prefilter.

public sealed class GeoBoundingBox : ValueObject, IComparable<ValueObject>, IComparable, IEquatable<ValueObject>

Inheritance

object

ValueObject

GeoBoundingBox

Implements

IComparable<ValueObject>

IComparable

IEquatable<ValueObject>

Inherited Members

ValueObject.Equals(object)

ValueObject.Equals(ValueObject)

ValueObject.GetHashCode()

ValueObject.CompareTo(ValueObject)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Func<Error>)

NullableExtensions.ToResult<T>(T?, Error)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Remarks

Longitude always increases from MinimumLongitude to MaximumLongitude. A search area that crosses the antimeridian is represented by two boxes in GeoBounds, never by a box whose minimum longitude is greater than its maximum.

Properties

MaximumLatitude

Gets the inclusive northern latitude in decimal degrees.

public double MaximumLatitude { get; }

Property Value

double

MaximumLongitude

Gets the inclusive eastern longitude in decimal degrees.

public double MaximumLongitude { get; }

Property Value

double

MinimumLatitude

Gets the inclusive southern latitude in decimal degrees.

public double MinimumLatitude { get; }

Property Value

double

MinimumLongitude

Gets the inclusive western longitude in decimal degrees.

public double MinimumLongitude { get; }

Property Value

double

World

Gets a box covering every valid coordinate.

public static GeoBoundingBox World { get; }

Property Value

GeoBoundingBox

Methods

Contains(GeoCoordinate)

Checks whether the coordinate's stored components fall inside this rectangle.

public bool Contains(GeoCoordinate coordinate)

Parameters

coordinate GeoCoordinate

The coordinate to test.

Returns

bool

true when both components are within the inclusive bounds.

Exceptions

ArgumentNullException

coordinate is null.

GetEqualityComponents(ref EqualityComponents)

When overridden in a derived class, adds the components that define equality for this value object.

protected override void GetEqualityComponents(ref EqualityComponents components)

Parameters

components EqualityComponents

The sink that collects this value object's equality components.

Examples

protected override void GetEqualityComponents(ref EqualityComponents components)
{
    components.Add(Street);
    components.Add(City);
    components.Add(PostalCode);
}

Remarks

This method is used by Equals(ValueObject?), GetHashCode(), and CompareTo(ValueObject?) to determine equality and ordering. Components must be added in a consistent order.

Guidelines:

• Add all properties that define the value object's identity
• For derived classes, call base.GetEqualityComponents(ref components) first
• Add components in a consistent, deterministic order
• Do not allocate: the sink exists so comparisons stay allocation-free