Class Goal<TGoal, TFeedback, TResult>

An actionlib goal that is associated with an action server.

Emits the following events:

'timeout' - If a timeout occurred while sending a goal.

Type Parameters

TGoal
TFeedback = unknown
TResult = unknown

Hierarchy

EventEmitter<
    {
        feedback: [TFeedback];
        result: [TResult];
        status: [actionlib_msgs.GoalStatus];
        timeout: undefined;
    },
>
- Goal

Index

Constructors

constructor

new Goal<TGoal, TFeedback = unknown, TResult = unknown>(
    options: {
        actionClient: ActionClient<TGoal, TFeedback, TResult>;
        goalMessage: TGoal;
    },
): Goal<TGoal, TFeedback, TResult>
Type Parameters
- TGoal
- TFeedback = unknown
- TResult = unknown
Parameters
- options: { actionClient: ActionClient<TGoal, TFeedback, TResult>; goalMessage: TGoal }
  - actionClient: ActionClient<TGoal, TFeedback, TResult>
    The ROSLIB.ActionClient to use with this goal.
  - goalMessage: TGoal
    The JSON object containing the goal for the action server.
Returns Goal<TGoal, TFeedback, TResult>
Overrides EventEmitter<{ timeout: undefined; status: [actionlib_msgs.GoalStatus]; feedback: [TFeedback]; result: [TResult]; }>.constructor
- Defined in src/actionlib/Goal.ts:40

Properties

actionClient

actionClient: ActionClient<TGoal, TFeedback, TResult>

`Optional`feedback

feedback?: TFeedback = undefined

goalID

goalID: string = ...

goalMessage

goalMessage: { goal: TGoal; goal_id: GoalID }

isFinished

isFinished: boolean = false

`Optional`result

result?: TResult = undefined

`Optional`status

status?: actionlib_msgs.GoalStatus = undefined

`Static`prefixed

prefixed: string | boolean

Methods

addListener

addListener<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              result: [TResult];
              status: [actionlib_msgs.GoalStatus];
              timeout: undefined;
          },
      >[Extract<T, "status" | "result" | "timeout" | "feedback">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

cancel

cancel(): void
Cancel the current goal.

Returns void
- Defined in src/actionlib/Goal.ts:96

emit

emit<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    ...args: ArgumentMap<
        {
            feedback: [TFeedback];
            result: [TResult];
            status: [actionlib_msgs.GoalStatus];
            timeout: undefined;
        },
    >[Extract<T, "status" | "result" | "timeout" | "feedback">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- ...args: ArgumentMap<
      {
          feedback: [TFeedback];
          result: [TResult];
          status: [actionlib_msgs.GoalStatus];
          timeout: undefined;
      },
  >[Extract<T, "status" | "result" | "timeout" | "feedback">]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): ("status" | "result" | "timeout" | "feedback")[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("status" | "result" | "timeout" | "feedback")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: "status" | "result" | "timeout" | "feedback"): number
Return the number of listeners listening to a given event.
Parameters
- event: "status" | "result" | "timeout" | "feedback"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
): (
    (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              result: [TResult];
              status: [actionlib_msgs.GoalStatus];
              timeout: undefined;
          },
      >[Extract<T, "status" | "result" | "timeout" | "feedback">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              result: [TResult];
              status: [actionlib_msgs.GoalStatus];
              timeout: undefined;
          },
      >[Extract<T, "status" | "result" | "timeout" | "feedback">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              result: [TResult];
              status: [actionlib_msgs.GoalStatus];
              timeout: undefined;
          },
      >[Extract<T, "status" | "result" | "timeout" | "feedback">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "status" | "result" | "timeout" | "feedback"): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "status" | "result" | "timeout" | "feedback"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends "status" | "result" | "timeout" | "feedback">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            {
                feedback: [TFeedback];
                result: [TResult];
                status: [actionlib_msgs.GoalStatus];
                timeout: undefined;
            },
        >[Extract<T, "status" | "result" | "timeout" | "feedback">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "status" | "result" | "timeout" | "feedback"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          {
              feedback: [TFeedback];
              result: [TResult];
              status: [actionlib_msgs.GoalStatus];
              timeout: undefined;
          },
      >[Extract<T, "status" | "result" | "timeout" | "feedback">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

send

send(timeout?: number): void
Send the goal to the action server.
Parameters
- Optionaltimeout: number
  A timeout length for the goal's result.
Returns void
- Defined in src/actionlib/Goal.ts:83

Class Goal<TGoal, TFeedback, TResult>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

actionClient: ActionClient<TGoal, TFeedback, TResult>

goalMessage: TGoal

Returns Goal<TGoal, TFeedback, TResult>

Properties

actionClient

Optionalfeedback

goalID

goalMessage

isFinished

Optionalresult

Optionalstatus

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

cancel

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns ("status" | "result" | "timeout" | "feedback")[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap< { feedback: [TFeedback]; result: [TResult]; status: [actionlib_msgs.GoalStatus]; timeout: undefined; }, >[Extract<T, "status" | "result" | "timeout" | "feedback">], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

send

Parameters

Returns void

Settings

On This Page

`Optional`feedback

`Optional`result

`Optional`status

`Static`prefixed

Returns (
(
...args: ArgumentMap<
{
feedback: [TFeedback];
result: [TResult];
status: [actionlib_msgs.GoalStatus];
timeout: undefined;
},
>[Extract<T, "status" | "result" | "timeout" | "feedback">],
) => void
)[]