Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProgramManager

IProgramManager have executing DRL APIs. For example, etc...

api-version

1

user

Hierarchy

Index

Properties

errorHandlingStatus: Monitorable<{ mode: ErrorHandlingMode; state: ErrorHandlingState }>

Monitorable for error hanlding state monitoring information

api-version

2

user
monitoringVariables: Monitorable<MonitoringVariable[]>

Monitorable for monitoring Variable

api-version

1

user
programExecuteLine: Monitorable<{ elapseTime: number; fileName: string; lineNumber: number }>
api-version

1

user
programState: Monitorable<ProgramState>
api-version

1

user
programStopCause: Monitorable<ProgramStopCause>
api-version

1

user
runningProgramInfo: Monitorable<RunningProgramInfo>
api-version

1

user
userEvent: Monitorable<{ data: string; eventName: string }>

Monitorable for 'message_to_dp' DRL.

api-version

2

user
userInputPopup: Monitorable<{ text: string; type: UserInputType }>

Monitorable for 'tp_get_user_input' DRL.

api-version

1

user
userLog: Monitorable<string>

Monitorable for 'tp_log' DRL.

api-version

1

user
userPopup: Monitorable<{ buttonType: UserPopupButtonType; level: UserPopupLevel; text: string }>

Monitorable for 'tp_popup' DRL.

api-version

1

user
waitHandGuide: Monitorable<boolean>

Monitorable for 'wait_manual_guide' DRL.

api-version

1

user
waitNudge: Monitorable<boolean>

Monitorable for 'wait_nudge' DRL.

api-version

1

user

Methods

  • addBreakPoint(line: number): Promise<boolean>
  • Add a break point.

    api-version

    1

    user

    Parameters

    • line: number

      line number

    Returns Promise<boolean>

  • addBreakPointSubProgram(line: number, fileName: string): Promise<boolean>
  • Add a brake point to the sub program.

    api-version

    3

    user

    Parameters

    • line: number

      line number

    • fileName: string

      sub program file name

    Returns Promise<boolean>

  • checkSyntax(script: string): Promise<boolean>
  • Request to check DRL Syntax. A logAlarm pop-up if there is a drl syntax problem.

    api-version

    1

    user

    Parameters

    • script: string

      DRL script as string.

    Returns Promise<boolean>

  • deleteBreakPoint(line: number): Promise<boolean>
  • Delete a break point.

    api-version

    1

    user

    Parameters

    • line: number

      line number

    Returns Promise<boolean>

  • deleteBreakPointSubProgram(line: number, fileName: string): Promise<boolean>
  • Delete a brake point to the sub program.

    api-version

    3

    user

    Parameters

    • line: number

      line number

    • fileName: string

      sub program file name

    Returns Promise<boolean>

  • pauseProgram(): Promise<boolean>
  • Request to pause program.

    api-version

    1

    user

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • registerSubProgramInterceptor(interceptor: ((program: string) => void), targetProgramNames: string[]): void
  • Register a callback to intercept sub programs. This function should be used for only system features (i.e. Task Editor's export).

    api-version

    1

    system

    Parameters

    • interceptor: ((program: string) => void)
        • (program: string): void
        • Parameters

          • program: string

          Returns void

    • targetProgramNames: string[]

    Returns void

  • resetBreakPoint(): Promise<boolean>
  • resetBreakPointSubProgram(fileName: string): Promise<boolean>
  • Reset the brake points to the sub program.

    api-version

    3

    user

    Parameters

    • fileName: string

      sub program file name

    Returns Promise<boolean>

  • resumeProgram(): Promise<boolean>
  • Request to resume program.

    api-version

    1

    user

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • runProgram(mainProgram: string, subPrograms: null | SubProgram[], monitoringVariables: null | MonitoringVariable[], useDebug: boolean): Promise<boolean>
  • Request to run program.

    api-version

    1

    user

    Parameters

    • mainProgram: string

      Main DRL program data as string.

    • subPrograms: null | SubProgram[]

      Sub DRL program data as array.

    • monitoringVariables: null | MonitoringVariable[]

      An array of variables which are needed to monitoring.

    • useDebug: boolean

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • runProgramWithProps(program: string, props?: { manualMode?: boolean; monitoringVariables?: MonitoringVariable[]; subPrograms?: SubProgram[]; useDebug?: boolean }): Promise<boolean>
  • Request to run program with properties.

    api-version

    3

    system

    Parameters

    • program: string

      DRL program data as string.

    • Optional props: { manualMode?: boolean; monitoringVariables?: MonitoringVariable[]; subPrograms?: SubProgram[]; useDebug?: boolean }

      Additional options.

      • Optional manualMode?: boolean
      • Optional monitoringVariables?: MonitoringVariable[]
      • Optional subPrograms?: SubProgram[]
      • Optional useDebug?: boolean

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

  • saveSubProgram(mode: ProgramSaveMode, programName: string, program?: string): Promise<boolean>
  • Save subprogram data which will be loaded and used in the main program to the Controller. The data will be deleted automatically after running DRL program. To prevent duplication of program names between modules, the {@link programName} must start with the requester's package name which has been replaced from dot (".") to underscore ("_"). For example, when a module whose package name is 'dart.module.xxx' tries to save a subprogram, the program name must start with 'dart_module_xxx' (ex. dart_module_xxx_mycommand).

    api-version

    1

    user

    Parameters

    • mode: ProgramSaveMode

      ProgramSaveMode for the program data

    • programName: string

      Program name. The name will be used to load the program in main program. The name must start with the requester's package name which has been replaced from dot (".") to underscore ("_").

    • Optional program: string

      Program data which is written by DRL.

    Returns Promise<boolean>

    Return Fulfills with true if the request has been operated successfully, otherwise false.

  • sendUserEventResponse(eventName: string, data: string): Promise<boolean>
  • After 'message_to_dp' (userEvent) drl-command during DRL program operation, it ends and resumes the next paused program.

    api-version

    2

    user

    Parameters

    • eventName: string

      Event name to send to DRL program.

    • data: string

      Data to transfer to DRL program.

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • sendUserInputPopupResponse(userInput: string): Promise<boolean>
  • After 'tp_get_user_input' (userInputPopup) drl-command during DRL program operation, it ends and resumes the next paused program.

    api-version

    1

    user

    Parameters

    • userInput: string

      user input value

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • sendUserPopupResponse(resume: boolean): Promise<boolean>
  • After 'tp_popup' (userPopup) drl-command during DRL program operation, it ends and resumes the next paused program.

    api-version

    1

    user

    Parameters

    • resume: boolean

      true: resume, false: stop

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • sendWaitHandGuideResponse(): Promise<boolean>
  • After entering the direct teaching mode by the 'wait_manual_guide' drl-command during DRL program operation, it ends and resumes the next paused program.

    api-version

    1

    user

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • sendWaitNudgeResponse(): Promise<boolean>
  • After entering the nudge mode by the 'wait_nudge' drl-command during DRL program operation, it ends and resumes the next paused program.

    api-version

    1

    user

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • stepRunProgram(lines: number): Promise<boolean>
  • Executes the DRL program from the current line to the specified number of lines at once.

    api-version

    1

    user

    Parameters

    • lines: number

      number of step lines

    Returns Promise<boolean>

    Return true if the request has been operated successfully, otherwise false.

  • unregisterSubProgramInterceptor(interceptor: ((program: string) => void)): void
  • Unregister the interceptor callback.

    api-version

    1

    system

    Parameters

    • interceptor: ((program: string) => void)
        • (program: string): void
        • Parameters

          • program: string

          Returns void

    Returns void

Generated using TypeDoc