AWFRiver

Objective-C

@interface AWFRiver : AWFGeographicObject

Swift

class AWFRiver : AWFGeographicObject

An AWFRiver object represents data returned by the rivers endpoint of the Aeris Weather API.

  • The river gauge identifier.

    Declaration

    Objective-C

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

    Swift

    var stationId: String? { get set }

  • GMT date for the observation.

    Declaration

    Objective-C

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

    Swift

    var timestamp: Date { get set }
  • obs

    The latest river observation.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) AWFRiverObservation *obs;

    Swift

    var obs: AWFRiverObservation? { get set }

  • The latest river observation from a secondary sensor when the guage includes a backup. This value is typically nil since most guages do not include backups.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) AWFRiverObservation *secondaryObs;

    Swift

    var secondaryObs: AWFRiverObservation? { get set }

  • The current river/lake status:

    • out_of_service: Gauge is known to be out of service
    • obs_not_current: Gauge has not reported updated observations recently
    • not_defined: Gauge is reporting observations but has no action/flooding levels defined and cannot determine if flooding
    • low_threshold: Gauge is reporting levels below the defined low water threshold
    • no_flooding: Gauge is reporting observations below flood and action levels
    • action: Gauge is reporting observations at or above action levels and near flood stage
    • minor: Gauge is reporting levels at or above the defined minor flood level
    • moderate: Gauge is reporting levels at or above the defined moderate flood level
    • major: Gauge is reporting levels at or above the defined major flood level

    Declaration

    Objective-C

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

    Swift

    var status: String? { get set }

  • The numeric code corresponding to the current river/lake status:

    • -1: out_of_service
    • 0: obs_not_current
    • 1: not_defined
    • 3: low_threshold
    • 5: no_flooding
    • 7: action
    • 9: minor
    • 11: moderate
    • 13: major

    Declaration

    Objective-C

    @property (nonatomic) CGFloat statusCode;

    Swift

    var statusCode: CGFloat { get set }

  • Local impacts if available and river is flooding, or nil if unavailable or river is not flooding.

    Declaration

    Objective-C

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

    Swift

    var impacts: String? { get set }

  • The body of water where the gauge is located.

    Declaration

    Objective-C

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

    Swift

    var waterbody: String? { get set }

  • The categories for various flood and action levels at the gauge location when available.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWFRiverCategory *> *_Nonnull categories;

    Swift

    var categories: [AWFRiverCategory] { get set }

  • A Boolean indicating whether the gauge contains flooding impacts.

    Declaration

    Objective-C

    @property (nonatomic) BOOL hasImpacts;

    Swift

    var hasImpacts: Bool { get set }