Class ProgramBehaviorAPI

Provides access to Program related API features in both BehaviorWorkers and ProgramPresenters

Hierarchy

  • CommonBehaviorAPI
    • ProgramBehaviorAPI

Constructors

constructor

Properties

applicationService builder logMessageService logPerformanceService programTreeService robotInfoService robotPositionService ros2Client safetyService settingsService sourceService symbolService

Methods

getContainerContributionURL

Constructors

constructor

  • Creates a new instance of the ProgramBehaviorAPI to allow communication with the surrounding application from within a WebWorker

    Parameters

    • target: EventTarget | Worker

      A worker, provided with 'self' when created inside a web worker

    Returns ProgramBehaviorAPI

Properties

applicationService

applicationService: ApplicationService

builder

builder: TreeBuilder

logMessageService

logMessageService: LogMessageService

logPerformanceService

logPerformanceService: LogPerformanceService

programTreeService

programTreeService: ProgramTreeService

robotInfoService

robotInfoService: RobotInfoService

robotPositionService

robotPositionService: RobotPositionService

ros2Client

ros2Client: Ros2Client

safetyService

safetyService: SafetyService

settingsService

settingsService: SettingsService

sourceService

sourceService: SourceService

symbolService

symbolService: SymbolService

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