Class RobotMoveService

RobotMoveService handles movement screen navigation

Hierarchy

MessageInvokerService
- RobotMoveService

Index

Constructors

Properties

Methods

autoMove openMoveScreen postAndAwait postAndObserve

Constructors

constructor

new RobotMoveService(eventTarget: EventTarget): RobotMoveService
Parameters
- eventTarget: EventTarget
Returns RobotMoveService
Overrides MessageInvokerService.constructor
- Defined in contribution-api/lib/services/robot/robot-move.service.d.ts:14

Properties

`Readonly` eventTarget

eventTarget: EventTarget

Methods

autoMove

autoMove(targetPosition: JointPositions | Waypoint): Promise<void>
Opens the autoMove screen
Parameters
- targetPosition: JointPositions | Waypoint
  
  Joint vector to move to
Returns Promise<void>
- Defined in contribution-api/lib/services/robot/robot-move.service.d.ts:24

openMoveScreen

openMoveScreen(options: MoveScreenOptions): Promise<Waypoint>
Opens the move screen and returns the selected position of the robot. Returns undefined if cancel is selected
Parameters
- options: MoveScreenOptions
  
  Move screen options
Returns Promise<Waypoint>
- Defined in contribution-api/lib/services/robot/robot-move.service.d.ts:19

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
- Optional data: any
  
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in contribution-api/lib/services/message-invoker.d.ts:44

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
- Optional data: any
  
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in contribution-api/lib/services/message-invoker.d.ts:51

Generated using TypeDoc