Class ProgramTreeService

Service that handles node insertion and removal of nodes

Hierarchy (View Summary)

MessageInvokerService
- ProgramTreeService

Index

Constructors

constructor

new ProgramTreeService(
eventTarget: EventTargetOrCommChannel,
): ProgramTreeService
Parameters
- eventTarget: EventTargetOrCommChannel
Returns ProgramTreeService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

addBlockChildNode

addBlockChildNode(node: AddBlockChildNode): Promise<void>
Add a node to the root of a program block, for example the main program or the before start
Parameters
- node: AddBlockChildNode
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:36

addNode

addNode(node: AddNode): Promise<void>
Add node as either child or sibling
Parameters
- node: AddNode
  node to be added
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:30

getContributedNodeInstancesForURCap

getContributedNodeInstancesForURCap(): Promise<SubtreeNode[]>
Get the contributed node instances for the URCap that are currently inserted in the program

Returns Promise<SubtreeNode[]>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:72

getProgramNodeById

getProgramNodeById(nodeID: string): Promise<Readonly<ProgramNode>>
Get a readonly version of a given node
Parameters
- nodeID: string
  The node to get
Returns Promise<Readonly<ProgramNode>>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:56

getSubtreeContextFromProgramNodeById

getSubtreeContextFromProgramNodeById(
subTreeNodeId: string,
): Promise<SubtreeContext>
Get the subtree context from a given program node. This returns the same traversals as getTreeContextFromProgramNodeById but will return a SubtreeNode for ancestor and sibling calls. For ancestor and sibling calls, where a SubtreeNode is not from the calling URCap, then the SubtreeNode id will be ''.
Parameters
- subTreeNodeId: string
Returns Promise<SubtreeContext>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:68

getTreeContextFromProgramNodeById

getTreeContextFromProgramNodeById(subTreeNodeId: string): Promise<TreeContext>
Get the tree context from a given program node
Parameters
- subTreeNodeId: string
Returns Promise<TreeContext>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:60

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

removeChildNode

removeChildNode(node: RemoveNode): Promise<void>
Remove child node
Parameters
- node: RemoveNode
  Child node to be removed
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:41

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

selectProgramNode

selectProgramNode(nodeID: string): Promise<void>
Sets the given node as the active program block
Parameters
- nodeID: string
  The node to navigate to
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:51

setActiveProgramBlock

setActiveProgramBlock(nodeID: string): Promise<void>
Sets the given node as the active program block
Parameters
- nodeID: string
  The node to navigate to
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:46

updateChildNode

updateChildNode(node: SubtreeNode): Promise<void>
Update child node
Parameters
- node: SubtreeNode
  Child node to be updated
Returns Promise<void>
Deprecated
Use updateSubTreeNode instead
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:25

updateSubTreeNode

updateSubTreeNode(node: SubtreeNode): Promise<void>
Update a specific node in the program tree using the given nodes id
Parameters
- node: SubtreeNode
  Node to be updated
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:19

Class ProgramTreeService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProgramTreeService

Properties

communicationChannel

ReadonlyeventTarget

Methods

addBlockChildNode

Parameters

Returns Promise<void>

addNode

Parameters

Returns Promise<void>

getContributedNodeInstancesForURCap

Returns Promise<SubtreeNode[]>

getProgramNodeById

Parameters

Returns Promise<Readonly<ProgramNode>>

getSubtreeContextFromProgramNodeById

Parameters

Returns Promise<SubtreeContext>

getTreeContextFromProgramNodeById

Parameters

Returns Promise<TreeContext>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

removeChildNode

Parameters

Returns Promise<void>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

selectProgramNode

Parameters

Returns Promise<void>

setActiveProgramBlock

Parameters

Returns Promise<void>

updateChildNode

Parameters

Returns Promise<void>

Deprecated

updateSubTreeNode

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`eventTarget