Class Param<T>

constructor

• new Param<T = unknown>(options: { name: string; ros: Ros }): Param<T>

  Type Parameters

  • T = unknown

  Parameters

  • options: { name: string; ros: Ros }

    • name: string

      The param name, like max_vel_x.

    • ros: Ros

      The ROSLIB.Ros connection handle.

  Returns Param<T>

name

ros

delete

• delete(
      callback: (message: DeleteParamResponse) => void,
      failedCallback?: (error: string) => void,
  ): void

  Delete this parameter on the ROS server.

  Parameters

  • callback: (message: DeleteParamResponse) => void

    The callback function.

  • OptionalfailedCallback: (error: string) => void = console.error

    The callback function when the service call failed or the parameter deletion was unsuccessful.

  Returns void

get

• get(
      callback: (value: T) => void,
      failedCallback?: (error: string) => void,
  ): void

  Fetch the value of the param.

  Parameters

  • callback: (value: T) => void

    The callback function.

  • OptionalfailedCallback: (error: string) => void = console.error

    The callback function when the service call failed or the parameter retrieval was unsuccessful.

  Returns void

set

• set(
      value: T,
      callback?: (message: SetParamResponse) => void,
      failedCallback?: (error: string) => void,
  ): void

  Set the value of the param in ROS.

  Parameters

  • value: T

    The value to set param to.

  • Optionalcallback: (message: SetParamResponse) => void

    The callback function.

  • OptionalfailedCallback: (error: string) => void = console.error

    The callback function when the service call failed or the parameter setting was unsuccessful.

  Returns void