Interface IAddress
- Namespace
- XENBIT.ResQueServe.Abstractions.Interfaces
- Assembly
- RQS.Abstractions.dll
Represents a specific address within a district, providing detailed street-level information. This record extends the IAddressDistrict to include street name and potential street number ranges, which can be used to generate random house numbers within simulations.
public interface IAddress : IAddressDistrict, IAddressCity, IAddressCommune, IAddressState
- Inherited Members
Properties
Id
long Id { get; set; }
Property Value
Street
The name of the street for this address. This property is essential for locating the address within its district and city context. Is unique inside a district.
string Street { get; set; }
Property Value
StreetNumberMax
The maximum street number available for this address. Similar to the minimum street number, this optional field defines the upper limit for randomly generating house numbers within the simulation, providing flexibility in address allocation.
int? StreetNumberMax { get; set; }
Property Value
- int?
StreetNumberMin
The minimum street number available for this address. This optional field can be used in the simulation to randomly generate a house number within a defined range, starting from this minimum value.
int? StreetNumberMin { get; set; }
Property Value
- int?
Methods
GetCoordinatesAsync(string?, params ICoordinatesResolver[]?)
Asynchronously retrieves the geocoding result for this address using multiple resolvers, with the option to specify a house number.
Task<IGeocodingResult?> GetCoordinatesAsync(string? houseNumber, params ICoordinatesResolver[]? coordinatesResolver)
Parameters
houseNumberstringThe optional house number to refine the geocoding result.
coordinatesResolverICoordinatesResolver[]An array of coordinates resolvers to attempt resolving the address.
Returns
- Task<IGeocodingResult>
A task representing the asynchronous operation, with a result of IGeocodingResult if resolved; otherwise, null.