Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGroup

A group represents a list of robots sharing the same persistent state.

Group hold the events and shared variables for all robots in the group.

Events sent to a group or a robots will be broadcasted to all robots in that group.

Hierarchy

Implemented by

Index

Events

onEventsDescriptionsChanged

onEventsDescriptionsChanged: function

Type declaration

onVariablesChanged

onVariablesChanged: function

Type declaration

Properties

eventsDescriptions

eventsDescriptions: EventDescription[]

List of events registered on this group

id

id: NodeId

Unique Id of the node

nodes

nodes: Node[]

All nodes registed on this group

variables

variables: Variables

Shared variables registered on this group

see

setVariables

Methods

emitEvents

  • emitEvents(events: Events): Promise<any>
  • emitEvents(key: string, value: any): Promise<any>
  • emitEvents(key: string): Promise<any>

setEventsDescriptions

  • Set the events registered on the group.

    see

    INode.lock

    Parameters

    • events: EventDescription[]

      variables to set. Will erase any previously registered events.

      This client must holds a lock on at least one node of this group for the operation to be sucessful

    Returns Promise<any>

setVariables

  • setVariables(variables: Variables): Promise<any>
  • Set the shared variables registered on the group.

    see

    INode.lock

    Parameters

    • variables: Variables

      variables to set. Will erase any previous registered variables.

      This client must holds a lock on at least one node of this group for the operation to be sucessful

    Returns Promise<any>

watchSharedVariablesAndEvents

  • watchSharedVariablesAndEvents(flags: number): Promise<any>

Generated using TypeDoc