Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PerimeterTimeOverride

An override start and end time for a specific sub-scenario.

Hierarchy

  • PerimeterTimeOverride

Index

Properties

Accessors

Methods

Properties

Private _endTime

_endTime: DateTime | null = null

The time to use instead of {@link VectorFile#perimEndTime}.

Private _startTime

_startTime: DateTime | null = null

The time to use instead of {@link VectorFile#perimStartTime}.

subScenarioName

subScenarioName: string

The name of the sub-scenario.

Accessors

endTime

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

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

    deprecated

    Returns string

  • Set the override for the export end 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

lEndTime

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

  • Get the override for the export end 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 end 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

lStartTime

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

  • Get the override for the export start 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 start 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

startTime

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

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

    deprecated

    Returns string

  • Set the override for the export start 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

Methods

checkValid

getExportEndTime

  • getExportEndTime(): string

  • Returns string

getExportStartTime

  • getExportStartTime(): string

  • Returns string