AWFForecastModel

Objective-C

@interface AWFForecastModel : NSObject

Swift

class AWFForecastModel : NSObject

AWFForecastModel is a static class that contains information about the supported forecast models used throughout the library.

Class Methods

  • Returns a dictionary that maps each {@link AWFForecastModel} to its display name.

    Declaration

    Objective-C

    + (nonnull NSDictionary<AWFForecastModelType, NSString *> *)names;

    Swift

    class func names() -> [AWFForecastModelType : String]

  • Returns the time interval between periods covered by a model type.

    Declaration

    Objective-C

    + (NSTimeInterval)intervalForForecastModelType:
    (nonnull AWFForecastModelType)model;

    Swift

    class func interval(forForecastModelType model: AWFForecastModelType) -> TimeInterval

    Parameters

    model

    The model type to return the time interval for

    Return Value

    The time interval between periods for the model

  • Returns the maximum time covered by a model type.

    Declaration

    Objective-C

    + (NSTimeInterval)maxTimeRangeForForecastModelType:
    (nonnull AWFForecastModelType)model;

    Swift

    class func maxTimeRange(forForecastModelType model: AWFForecastModelType) -> TimeInterval

    Parameters

    model

    The model type to return the maximum time for

    Return Value

    The maximum time supported by the model