Table of Contents

Class FacilityQuery

Namespace
DotBahn.Facilities
Assembly
DotBahn.Facilities.dll

Represents the query parameters for searching facilities in stations. Provides fluent methods for convenient building of queries

public sealed record FacilityQuery : IEquatable<FacilityQuery>
Inheritance
FacilityQuery
Implements
Inherited Members

Constructors

FacilityQuery() 

public FacilityQuery()

Properties

EquipmentNumbers

Equipment numbers to filter by

public IEnumerable<string> EquipmentNumbers { get; set; }

Property Value

IEnumerable<string>

LatitudeNorth

Northernmost latitude in WGS84 decimal degrees for geographic bounding box filter Must be used together with LongitudeWest, LatitudeSouth, and LongitudeEast 

public double? LatitudeNorth { get; set; }

Property Value

double?

LatitudeSouth

Southernmost latitude in WGS84 decimal degrees for geographic bounding box filter Must be used together with LongitudeWest, LongitudeEast, and LatitudeNorth 

public double? LatitudeSouth { get; set; }

Property Value

double?

LongitudeEast

Easternmost longitude in WGS84 decimal degrees for geographic bounding box filter Must be used together with LongitudeWest, LatitudeSouth, and LatitudeNorth 

public double? LongitudeEast { get; set; }

Property Value

double?

LongitudeWest

Westernmost longitude in WGS84 decimal degrees for geographic bounding box filter Must be used together with LatitudeSouth, LongitudeEast, and LatitudeNorth 

public double? LongitudeWest { get; set; }

Property Value

double?

State

State of the facility

public FacilityState? State { get; set; }

Property Value

FacilityState?

StationId

The station ID to filter facilities

public string? StationId { get; set; }

Property Value

string

Type

Type of the facility

public FacilityType? Type { get; set; }

Property Value

FacilityType?

Methods

AtStation(int)

Filters facilities by station ID

public FacilityQuery AtStation(int stationId)

Parameters

stationId int

Returns

FacilityQuery

Equals(FacilityQuery?) 

public bool Equals(FacilityQuery? other)

Parameters

other FacilityQuery

Returns

bool

Equals(object?) 

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode() 

public override int GetHashCode()

Returns

int

ToString() 

public override string ToString()

Returns

string

WithArea(double, double, double, double)

Filters facilities within a geographic bounding box

public FacilityQuery WithArea(double lngWest, double latSouth, double lngEast, double latNorth)

Parameters

lngWest double

Westernmost longitude in WGS84 decimal degrees

latSouth double

Southernmost latitude in WGS84 decimal degrees

lngEast double

Easternmost longitude in WGS84 decimal degrees

latNorth double

Northernmost latitude in WGS84 decimal degrees

Returns

FacilityQuery

The current FacilityQuery instance for fluent chaining

WithEquipmentNumbers(params string[])

Filters facilities by one or more equipment numbers

public FacilityQuery WithEquipmentNumbers(params string[] numbers)

Parameters

numbers string[]

Returns

FacilityQuery

WithState(FacilityState)

Sets the facility state filter

public FacilityQuery WithState(FacilityState state)

Parameters

state FacilityState

Returns

FacilityQuery

WithType(FacilityType)

Sets the facility type filter

public FacilityQuery WithType(FacilityType type)

Parameters

type FacilityType

Returns

FacilityQuery

Operators

operator ==(FacilityQuery?, FacilityQuery?) 

public static bool operator ==(FacilityQuery? left, FacilityQuery? right)

Parameters

left FacilityQuery
right FacilityQuery

Returns

bool

operator !=(FacilityQuery?, FacilityQuery?) 

public static bool operator !=(FacilityQuery? left, FacilityQuery? right)

Parameters

left FacilityQuery
right FacilityQuery

Returns

bool