roslib
    Preparing search index...

    Class TFClient

    A TF Client that listens to TFs from tf2_web_republisher.

    Hierarchy

    • default
      • TFClient
    Index

    Constructors

    • Parameters

      • options: {
            angularThres?: number;
            fixedFrame?: string;
            rate?: number;
            ros: Ros;
            serverName?: string;
            topicTimeout?: number;
            transThres?: number;
            updateDelay?: number;
        }
        • OptionalangularThres?: number

          The angular threshold for the TF republisher.

        • OptionalfixedFrame?: string

          The fixed frame.

        • Optionalrate?: number

          The rate for the TF republisher.

        • ros: Ros

          The ROSLIB.Ros connection handle.

        • OptionalserverName?: string

          The name of the tf2_web_republisher server.

        • OptionaltopicTimeout?: number

          The timeout parameter for the TF republisher.

        • OptionaltransThres?: number

          The translation threshold for the TF republisher.

        • OptionalupdateDelay?: number

          The time (in ms) to wait after a new subscription to update the TF republisher's list of TFs.

      Returns TFClient

    Properties

    angularThres: number
    currentGoal: false | Goal<TFSubscriptionGoal, TFSubscriptionFeedback, unknown> = false
    currentTopic: false | Topic<TFMessage> = false
    fixedFrame: string
    frameInfos: Partial<
        Record<
            string,
            { cbs: ((tf: Transform) => void)[]; transform?: Transform },
        >,
    > = {}
    rate: number
    republisherUpdateRequested: boolean = false
    ros: Ros
    serverName: string
    topicTimeout: time
    transThres: number
    updateDelay: number

    Methods

    • Unsubscribe and unadvertise all topics associated with this TFClient.

      Returns void

    • Process the incoming TF message and send them out using the callback functions.

      Parameters

      • tf: TFMessage

        The TF message from the server.

      Returns void

    • Subscribe to the given TF frame.

      Parameters

      • frameID: string

        The TF frame to subscribe to.

      • callback: (transform: Transform) => void

        Function with the following params:

      Returns void

    • Unsubscribe from the given TF frame.

      Parameters

      • frameID: string

        The TF frame to unsubscribe from.

      • Optionalcallback: (transform: Transform) => void

        The callback function to remove.

      Returns void

    • Create and send a new goal (or service request) to the tf2_web_republisher based on the current list of TFs.

      Returns void