AWFIndexPeriod

Objective-C

@interface AWFIndexPeriod : AWFGeographicObject

Swift

class AWFIndexPeriod : AWFGeographicObject

An AWFIndexPeriod object represents data returned by the indices endpoint of the Aeris Weather API.

  • The current index item based on the latest observation for the location.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) AWFIndex *current;

    Swift

    var current: AWFIndex? { get set }

  • An array of index items for periods in the future. This value will be nil by default. In order to obtain forecast indices, you must provide a toDate with your request options.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray<AWFIndex *> *forecast;

    Swift

    var forecast: [AWFIndex]? { get set }

  • Minimum index value allowed for the index type.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat rangeMin;

    Swift

    var rangeMin: CGFloat { get set }

  • Maximum index value allowed for the index type.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat rangeMax;

    Swift

    var rangeMax: CGFloat { get set }

  • Index type this period pertains to.

    Declaration

    Objective-C

    @property (nonatomic, nullable) AWFIndexDataType type;

    Swift

    unowned(unsafe) var type: NSString? { get set }

  • Whether or not the index range values are reversed.

    By default, the index range is not reversed meaning that the lowest index value corresponds to the lowest risk or severity. When the range is reversed, the lowest index value corresponds to the greatest risk or severity.

    Declaration

    Objective-C

    @property (nonatomic) BOOL isReverse;

    Swift

    var isReverse: Bool { get set }