AWFDroughtIndex

Objective-C

@interface AWFDroughtIndex : AWFWeatherObject

Swift

class AWFDroughtIndex : AWFWeatherObject

An AWFDroughtIndex object that represents data returned by the droughts/monitor endpoint of the Aeris Weather API.

  • Unique identifier for the drought index.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *indexId;

    Swift

    var indexId: String? { get set }

  • Product type, normally “usdm”.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *product;

    Swift

    var product: String? { get set }

  • Drought category type.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *category;

    Swift

    var category: String? { get set }

  • Abbreviated risk type indicating the drought severity level.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *riskType;

    Swift

    var riskType: String? { get set }

  • Full risk name for the drought severity level.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *riskName;

    Swift

    var riskName: String? { get set }

  • Risk code for the drought severity level.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger riskCode;

    Swift

    var riskCode: Int { get set }

  • Starting date covered by the drought index.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate *startDate;

    Swift

    var startDate: Date? { get set }

  • Ending date covered by the drought index.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate *endDate;

    Swift

    var endDate: Date? { get set }

  • Date when the drought index was issued.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDate *timestamp;

    Swift

    var timestamp: Date? { get set }

  • An array of AWFGeoPolygon instances that define the coverage area(s) for the drought index.

    In order to return polygons with your request, you must also include the geo filter with your request options. If this filter is not included and/or there is no associated risk with this outlook, then this value will be nil.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray<AWFGeoPolygon *> *polygons;

    Swift

    var polygons: [AWFGeoPolygon]? { get set }

  • An array of AWFGeoPolygon instances that define the interior, or cutout, regions of the polygon(s), if any.

    Interior polygons are primarily used by mapping frameworks to determine where hallow areas should be rendered in the parent polygon.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray<AWFGeoPolygon *> *interiorPolygons;

    Swift

    var interiorPolygons: [AWFGeoPolygon]? { get set }