Class ActionClient<TGoal, TFeedback, TResult>

An actionlib action client.

Emits the following events:

'timeout' - If a timeout occurred while sending a goal.
'status' - The status messages received from the action server.
'feedback' - The feedback messages received from the action server.
'result' - The result returned from the action server.

Type Parameters

TGoal = unknown
TFeedback = unknown
TResult = unknown

Hierarchy

EventEmitter<{ timeout: undefined }>
- ActionClient

Constructors

constructor

new ActionClient<TGoal = unknown, TFeedback = unknown, TResult = unknown>(
    options: {
        actionName: string;
        omitFeedback?: boolean;
        omitResult?: boolean;
        omitStatus?: boolean;
        ros: Ros;
        serverName: string;
        timeout?: number;
    },
): ActionClient<TGoal, TFeedback, TResult>
Type Parameters
- TGoal = unknown
- TFeedback = unknown
- TResult = unknown
Parameters
- options: {
      actionName: string;
      omitFeedback?: boolean;
      omitResult?: boolean;
      omitStatus?: boolean;
      ros: Ros;
      serverName: string;
      timeout?: number;
  }
  - actionName: string
    The action message name, like 'actionlib_tutorials/FibonacciAction'.
  - OptionalomitFeedback?: boolean
    The flag to indicate whether to omit the feedback channel or not.
  - OptionalomitResult?: boolean
    The flag to indicate whether to omit the result channel or not.
  - OptionalomitStatus?: boolean
    The flag to indicate whether to omit the status channel or not.
  - ros: Ros
    The ROSLIB.Ros connection handle.
  - serverName: string
    The action server name, like '/fibonacci'.
  - Optionaltimeout?: number
    The timeout length when connecting to the action server.
Returns ActionClient<TGoal, TFeedback, TResult>
Overrides EventEmitter<{ timeout: undefined; }>.constructor
- Defined in src/actionlib/ActionClient.ts:60

Properties

actionName

actionName: string

cancelTopic

cancelTopic: Topic<Partial<GoalID>>

feedbackListener

feedbackListener: Topic<
{ feedback: TFeedback; status: actionlib_msgs.GoalStatus },
>

goals

goals: Partial<Record<string, Goal<TGoal>>> = {}

goalTopic

goalTopic: Topic<{ goal: TGoal; goal_id: GoalID }>

`Optional`omitFeedback

omitFeedback?: boolean

`Optional`omitResult

omitResult?: boolean

`Optional`omitStatus

omitStatus?: boolean

receivedStatus

receivedStatus: boolean = false

flag to check if a status has been received

resultListener

resultListener: Topic<{ result: TResult; status: actionlib_msgs.GoalStatus }>

ros

ros: Ros

serverName

serverName: string

statusListener

statusListener: Topic<GoalStatusArray>

`Optional`timeout

timeout?: number

`Static`prefixed

prefixed: string | boolean

Methods

addListener

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

cancel

cancel(): void
Cancel all goals associated with this ActionClient.

Returns void
- Defined in src/actionlib/ActionClient.ts:169

dispose

dispose(): void
Unsubscribe and unadvertise all topics associated with this ActionClient.

Returns void
- Defined in src/actionlib/ActionClient.ts:176

emit

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

eventNames

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

Returns "timeout"[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

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

listeners

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

off

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

on

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

once

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

removeAllListeners

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

removeListener

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

Class ActionClient<TGoal, TFeedback, TResult>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

actionName: string

OptionalomitFeedback?: boolean

OptionalomitResult?: boolean

OptionalomitStatus?: boolean

ros: Ros

serverName: string

Optionaltimeout?: number

Returns ActionClient<TGoal, TFeedback, TResult>

Properties

actionName

cancelTopic

feedbackListener

goals

goalTopic

OptionalomitFeedback

OptionalomitResult

OptionalomitStatus

receivedStatus

resultListener

ros

serverName

statusListener

Optionaltimeout

Staticprefixed

Methods

addListener

Type Parameters

Parameters

Returns this

cancel

Returns void

dispose

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns "timeout"[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: ArgumentMap<{ timeout: undefined }>[Extract<T, "timeout">]) => 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

Settings

On This Page

`Optional`omitFeedback?: boolean

`Optional`omitResult?: boolean

`Optional`omitStatus?: boolean

`Optional`timeout?: number

`Optional`omitFeedback

`Optional`omitResult

`Optional`omitStatus

`Optional`timeout

`Static`prefixed