Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExportTimeOverride

Override the output time for a specific sub-scenario.

Hierarchy

  • ExportTimeOverride

Index

Properties

Accessors

Methods

Properties

Private _exportTime

_exportTime: DateTime | null = null

The export time to use instead of the one defined in the Output_GridFile class.

subScenarioName

subScenarioName: string | null = null

The name of the sub-scenario that the override time is for.

Accessors

exportTime

  • get exportTime(): string
  • set exportTime(value: string): void

  • Get the override for the export time as an ISO8601 string.

    deprecated

    Returns string

  • Set the override for the export time using a string. Cannot be null or empty. Must be formatted in ISO8601.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    deprecated

    Parameters

    • value: string

    Returns void

lExportTime

  • get lExportTime(): DateTime | null
  • set lExportTime(value: DateTime | null): void

  • Get the override for the export time as a Luxon DateTime.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    Returns DateTime | null

  • Set the override for the export time using a Luxon DateTime. Cannot be null.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    Parameters

    • value: DateTime | null

    Returns void

Methods

checkValid

getExportOverrideTime

  • getExportOverrideTime(): string

  • Returns string