StandardScenarioType

enum StandardScenarioType

Pre-defined simulation scenarios. These could be deduced from the specification, but an enum makes them easier for a client to look up.

  • Unspecified standard scenario type. Details must be provided in the scenario definition.

    Declaration

    Swift

    case standardScenarioTypeUnspecified
  • Uses historical settings and weather data. This is a baseline scenario for estimating historical savings and for comparing energy use across months. If this scenario is projected into the future, the latest settings before the forecast are used.

    Declaration

    Swift

    case standardScenarioTypeBaseline
  • Overrides all heating and cooling targets with comfortable values, derived from the targets used over this device’s history.

    Declaration

    Swift

    case standardScenarioTypeComfortTargetOverrides
  • Creates a new instance with the specified raw value.

    If there is no value of the type that corresponds with the specified raw value, this initializer returns nil. For example:

    enum PaperSize: String {
        case A4, A5, Letter, Legal
    }
    
    print(PaperSize(rawValue: "Legal"))
    // Prints "Optional(PaperSize.Legal)"
    
    print(PaperSize(rawValue: "Tabloid"))
    // Prints "nil"
    

    Declaration

    Swift

    init?(rawValue: UInt64)

    Parameters

    rawValue

    The raw value to use for the new instance.