Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JobDefaults

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

fbpDefaults

fbpDefaults: FBPOptions

The FBP defaults

Protected fetchState

fetchState: number = 0

fgmDefaults

fgmDefaults: FGMOptions

The fire growth model defaults.

fmcDefaults

fmcDefaults: FMCOptions

The FMC defaults

interpDefaults

interpDefaults: FWIOptions

The interpolate defaults

jobDirectory

jobDirectory: string

The job outputs directory.

metadataDefaults

metadataDefaults: VectorMetadata

The metadata defaults

Static Readonly TYPE_JOBLOCATION

TYPE_JOBLOCATION: string = "JOBLOCATION"

Methods

getDefaults

  • getDefaults(callback?: (defaults: JobDefaults) => any): void

  • Get the job defaults from the job manager.

    Parameters

    Returns void

Private getDefaultsInternal

  • getDefaultsInternal(callback?: (defaults: JobDefaults) => any, error?: (message: any) => any): void

  • Parameters

    • Optional callback: (defaults: JobDefaults) => any
    • Optional error: (message: any) => any
        • (message: any): any

        • Parameters

          • message: any

          Returns any

    Returns void

getDefaultsPromise

  • Get the job defaults from the job manager.

    throws

    This method can only be called once at a time per instance.

    Returns Promise<JobDefaults>

    The current JobDefaults object.

setBuilderIP

  • setBuilderIP(address: string): void

  • Set the IP address of the machine the Java builder is running on.

    deprecated

    Set the port and address directly using {@link SocketHelper#initialize(string,int)}.

    Parameters

    • address: string

      The IP address of the computer running the Java builder application.

    Returns void

setBuilderPort

  • setBuilderPort(port: number): void

  • Set the port used to communicate with the Java builder.

    deprecated

    Set the port and address directly using {@link SocketHelper#initialize(string,int)}.

    Parameters

    • port: number

      The port to communicate on. Must be the same one the Java builder has been configured to listen on.

    Returns void

Private tryParse

  • tryParse(type: string, data: string): boolean

  • Parameters

    • type: string
    • data: string

    Returns boolean