AWFConvectiveOutlook

Objective-C

@interface AWFConvectiveOutlook : AWFWeatherObject

Swift

class AWFConvectiveOutlook : AWFWeatherObject

An AWFConvectiveOutlook object represents data returned by the convective/outlook endpoint of the Aeris Weather API.

  • Unique identifier for the outlook.

    Declaration

    Objective-C

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

    Swift

    var outlookId: String? { get set }

  • Product type, normally “convective”.

    Declaration

    Objective-C

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

    Swift

    var product: String? { get set }

  • Outlook category type.

    Declaration

    Objective-C

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

    Swift

    var category: String? { get set }

  • Coverage day for the outlook from 1-8.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger dayIndex;

    Swift

    var dayIndex: Int { get set }

  • Abbreviated risk type.

    Declaration

    Objective-C

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

    Swift

    var riskType: String? { get set }

  • Full risk name as provided by the Storm Prediction Center (SPC).

    Declaration

    Objective-C

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

    Swift

    var riskName: String? { get set }

  • Risk code.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger riskCode;

    Swift

    var riskCode: Int { get set }

  • Starting date covered by the outlook.

    Declaration

    Objective-C

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

    Swift

    var startDate: Date? { get set }

  • Ending date covered by the outlook.

    Declaration

    Objective-C

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

    Swift

    var endDate: Date? { get set }

  • Date when the outlook 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 outlook.

    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 }