Class VariableService

Service for generating and getting reserved variable names

Hierarchy (View Summary)

MessageInvokerService
- VariableService

Index

Constructors

constructor

new VariableService(eventTarget: EventTargetOrCommChannel): VariableService
Create a service for the specific worker
Parameters
- eventTarget: EventTargetOrCommChannel
Returns VariableService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/variable.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

createVariable

createVariable(
    name: string,
    variableType:
        | "string"
        | "boolean"
        | "pose"
        | "frame"
        | "waypoint"
        | "float"
        | "integer"
        | "matrix"
        | "array"
        | "grid"
        | "timer"
        | "profile",
): Promise<VariableDeclaration>
Create a new variable declaration
Parameters
- name: string
  Actual name of the variable. Might be changed by the service to avoid name clashes
- variableType:
      | "string"
      | "boolean"
      | "pose"
      | "frame"
      | "waypoint"
      | "float"
      | "integer"
      | "matrix"
      | "array"
      | "grid"
      | "timer"
      | "profile"
  ValueType of the variable
Returns Promise<VariableDeclaration>
Promise resolving to the created variable declaration
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/variable.service.d.ts:25

getVariableDescription

getVariableDescription(
reference: VariableReference,
): Promise<VariableDescriptionWithReference | undefined>
Get a variable description from its reference
Parameters
- reference: VariableReference
  the variable reference
Returns Promise<VariableDescriptionWithReference | undefined>
Promise resolving to the variable description or undefined if not found
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/variable.service.d.ts:31

postAndAwait

postAndAwait<T>(type: string, data?: any): Promise<T>
returns a reply promise to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:192

postAndObserve

postAndObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:199

request

request<T>(type: string, data?: any): Promise<T>
returns a reply promise for the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:185

upgradeURVariable

upgradeURVariable(
variable: URVariable,
): Promise<VariableDeclaration | VariableReference | undefined>
Upgrade from URVariable to VariableDeclaration | VariableReference. If a variable with the property reference=true is provided, the corresponding VariableReference is returned. If a variable with reference=false is provided, a VariableDeclaration is returned.
Parameters
- variable: URVariable
  URVariable to upgrade
Returns Promise<VariableDeclaration | VariableReference | undefined>
Promise resolving to the VariableDeclaration | VariableReference | undefined if not found
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/variable.service.d.ts:39

variables

variables(): Observable<VariableDescriptionWithReference[]>
Get a list of available variables

Returns Observable<VariableDescriptionWithReference[]>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/variable.service.d.ts:18

Class VariableService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VariableService

Properties

communicationChannel

ReadonlyeventTarget

Methods

createVariable

Parameters

Returns Promise<VariableDeclaration>

getVariableDescription

Parameters

Returns Promise<VariableDescriptionWithReference | undefined>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

upgradeURVariable

Parameters

Returns Promise<VariableDeclaration | VariableReference | undefined>

variables

Returns Observable<VariableDescriptionWithReference[]>

Settings

On This Page

`Readonly`eventTarget