Class ProgramPresenterAPI

ProgramPresenterAPI

Hierarchy

  • CommonPresenterAPI
    • ProgramPresenterAPI

Constructors

constructor

Properties

applicationService builder dialogService logMessageService logPerformanceService programNodeService programTreeService robotInfoService robotMoveService robotPositionService ros2Client safetyService selectedNodeId settingsService snackbarService sourceService symbolService validationService

Methods

getContainerContributionURL

Constructors

constructor

  • Creates a new instance of the ProgramPresenterAPI, to allow communication with the surrounding application from within a WebComponent

    Parameters

    • target: EventTarget

      An EventTarget, provided by PolyScope X

    • selectedNodeId: string

      the Id of the current program node

    Returns ProgramPresenterAPI

Properties

applicationService

applicationService: ApplicationService

builder

builder: TreeBuilder

dialogService

dialogService: DialogService

logMessageService

logMessageService: LogMessageService

logPerformanceService

logPerformanceService: LogPerformanceService

programNodeService

programNodeService: ProgramNodeService

programTreeService

programTreeService: ProgramTreeService

robotInfoService

robotInfoService: RobotInfoService

robotMoveService

robotMoveService: RobotMoveService

robotPositionService

robotPositionService: RobotPositionService

ros2Client

ros2Client: Ros2Client

safetyService

safetyService: SafetyService

selectedNodeId

selectedNodeId: string

settingsService

settingsService: SettingsService

snackbarService

snackbarService: SnackbarService

sourceService

sourceService: SourceService

symbolService

symbolService: SymbolService

validationService

validationService: ValidationService

Methods

getContainerContributionURL

  • Creates a URL string for communicating with backend Container Contributions A protocol must be prepended to the string, like 'http://' or 'ws://'

    Returns

    URL string without protocol.

    Parameters

    • vendorID: string

      Id of Vendor as specified in manifest.yaml file

    • urcapID: string

      Id of URCap as specified in manifest.yaml file

    • containerName: string

      Name of Container as specified in manifest.yaml file

    • serviceName: string

      Name of Service as specified by Ingress name in manifest.yaml file

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc