Location |
Defines a request for info about the station(s) that would be used to fulfil
an equivalent LocationDataRequest.
Inheritance HierarchyNamespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
SyntaxThe LocationInfoRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LocationInfoRequest | Constructs a LocationInfoRequest object with the specified Location and DataSpecs. |
Properties| Name | Description | |
|---|---|---|
 | DataSpecs | Gets the non-null DataSpecs object that specifies the data that is desired from the specified location. |
| Location | Gets the non-null Location object for which data is desired. |
Methods| Name | Description | |
|---|---|---|
| Equals |
Two LocationInfoRequest objects are equal if it can be
ascertained that they are specifying the same set(s) of data from the
same location (i.e. they hold equal DataSpecs and
Location objects).
(Overrides ObjectEquals(Object)) |
| GetHashCode |
Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode) |
| ToString |
Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString) |
RemarksThis is effectively a lightweight alternative to LocationDataRequest, primarily for use when you want to know what station ID the API would use for a given GeographicLocation, without the overhead of actually fetching any data.
A successfully-processed LocationInfoRequest will result in a LocationInfoResponse.
LocationInfoRequest mirrors LocationDataRequest, so see that class's docs for information on how to create a LocationInfoRequest.
Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
Version History| Version | Description |
|---|---|
| 1.1 | This was added in version 1.1. |
See Also