Click or drag to resize
LocationInfoRequest Class
Defines a request for info about the station(s) that would be used to fulfil an equivalent LocationDataRequest.
Inheritance Hierarchy
SystemObject
  DegreeDays.ApiRequest
    DegreeDays.Api.DataLocationInfoRequest

Namespace: DegreeDays.Api.Data
Assembly: DegreeDaysApi (in DegreeDaysApi.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
public sealed class LocationInfoRequest : Request

The LocationInfoRequest type exposes the following members.

Constructors
  NameDescription
Public methodLocationInfoRequest
Constructs a LocationInfoRequest object with the specified Location and DataSpecs.
Top
Methods
  NameDescription
Public methodEquals
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).)
Public methodGetHashCode
Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode.)
Public methodToString
Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString.)
Top
Properties
  NameDescription
Public propertyDataSpecs
Gets the non-null DataSpecs object that specifies the data that is desired from the specified location.
Public propertyLocation
Gets the non-null Location object for which data is desired.
Top
Remarks

This 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.
See Also