Interface Gripper

Represents a physical robotic gripper.

interface Gripper {
    getGeometries: ((extra?) => Promise<commonApi.Geometry[]>);
    grab: ((extra?) => Promise<void>);
    isMoving: (() => Promise<boolean>);
    name: string;
    open: ((extra?) => Promise<void>);
    stop: ((extra?) => Promise<void>);
    doCommand(command): Promise<JsonValue>;
}

Hierarchy (view full)

Implemented by

Properties

getGeometries grab isMoving name open stop

Methods

doCommand

Properties

getGeometries

getGeometries: ((extra?) => Promise<commonApi.Geometry[]>)

Get the geometries of the component in their current configuration

Type declaration

grab

grab: ((extra?) => Promise<void>)

Request a gripper of the underlying robot to grab.

Type declaration

    • (extra?): Promise<void>

    • Parameters

      Returns Promise<void>

isMoving

isMoving: (() => Promise<boolean>)

Report if the gripper is in motion.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

Readonly name

name: string

The name of the resource.

open

open: ((extra?) => Promise<void>)

Open a gripper of the underlying robot.

Type declaration

    • (extra?): Promise<void>

    • Parameters

      Returns Promise<void>

stop

stop: ((extra?) => Promise<void>)

Stop a robot's gripper.

Type declaration

    • (extra?): Promise<void>

    • Parameters

      Returns Promise<void>

Methods

doCommand

Settings

Member Visibility

Theme

On This Page

getGeometriesgrabisMovingnameopenstopdoCommand