Skip to content

Index

autoware_universe_utils#

目的#

このパッケージには、他のパッケージで一般的に使用される関数が多数含まれているため、必要に応じて参照してください。

開発者向け#

プリプロセスに時間がかかるため、autoware_universe_utils.hpp ヘッダーファイルは削除されました。

autoware::universe_utils#

systems#

autoware::universe_utils::TimeKeeper#

コンストラクタ#
template <typename... Reporters>
explicit TimeKeeper(Reporters... reporters);
  • TimeKeeperをリポーターのリストで初期化します。
メソッド#

  • void add_reporter(std::ostream * os);

    • ostreamに出力処理時間をレポートするリポーターを追加します。
    • os: ostreamオブジェクトへのポインタ。

  • void add_reporter(rclcpp::Publisher<ProcessingTimeDetail>::SharedPtr publisher);

    • 処理時間をrclcppパブリッシャーにパブリッシュするリポーターを追加します。
    • publisher: rclcppパブリッシャーへの共有ポインタ。

  • void add_reporter(rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher);

    • 処理時間をstd_msgs::msg::Stringを使用したrclcppパブリッシャーにパブリッシュするリポーターを追加します。
    • publisher: rclcppパブリッシャーへの共有ポインタ。

  • void start_track(const std::string & func_name);

    • 関数の処理時間を追跡し始めます。
    • func_name: 追跡する関数の名前。

  • void end_track(const std::string & func_name);

    • 関数の処理時間の追跡を終了します。
    • func_name: 追跡を終了する関数の名前。
  • void comment(const std::string & comment);
    • 追跡中の現在の関数にコメントを追加します。
    • comment: 追加するコメント。
注釈#

  • 以下に示すように、start_trackとend_trackを使用して時間測定を開始および終了できます。

    time_keeper.start_track("example_function");
// Your function code here
time_keeper.end_track("example_function");
  • 安全性と適切な追跡を確保するために、ScopedTimeTrackの使用を推奨します。
例#
#include <rclcpp/rclcpp.hpp>

#include <std_msgs/msg/string.hpp>

#include <chrono>
#include <iostream>
#include <memory>
#include <thread>

class ExampleNode : public rclcpp::Node
{
public:
  ExampleNode() : Node("time_keeper_example")
  {
    publisher_ =
      create_publisher<autoware::universe_utils::ProcessingTimeDetail>("processing_time", 1);

    time_keeper_ = std::make_shared<autoware::universe_utils::TimeKeeper>(publisher_, &std::cerr);
    // You can also add a reporter later by add_reporter.
    // time_keeper_->add_reporter(publisher_);
    // time_keeper_->add_reporter(&std::cerr);

    timer_ =
      create_wall_timer(std::chrono::seconds(1), std::bind(&ExampleNode::func_a, this));
  }

private:
  std::shared_ptr<autoware::universe_utils::TimeKeeper> time_keeper_;
  rclcpp::Publisher<autoware::universe_utils::ProcessingTimeDetail>::SharedPtr publisher_;
  rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_str_;
  rclcpp::TimerBase::SharedPtr timer_;

  void func_a()
  {
    // Start constructing ProcessingTimeTree (because func_a is the root function)
    autoware::universe_utils::ScopedTimeTrack st("func_a", *time_keeper_);
    std::this_thread::sleep_for(std::chrono::milliseconds(1));
    time_keeper_->comment("This is a comment for func_a");
    func_b();
    // End constructing ProcessingTimeTree. After this, the tree will be reported (publishing
    // message and outputting to std::cerr)
  }

  void func_b()
  {
    autoware::universe_utils::ScopedTimeTrack st("func_b", *time_keeper_);
    std::this_thread::sleep_for(std::chrono::milliseconds(2));
    time_keeper_->comment("This is a comment for func_b");
    func_c();
  }

  void func_c()
  {
    autoware::universe_utils::ScopedTimeTrack st("func_c", *time_keeper_);
    std::this_thread::sleep_for(std::chrono::milliseconds(3));
    time_keeper_->comment("This is a comment for func_c");
  }
};

int main(int argc, char ** argv)
{
  rclcpp::init(argc, argv);
  auto node = std::make_shared<ExampleNode>();
  rclcpp::spin(node);
  rclcpp::shutdown();
  return 0;
}

  • 出力（コンソール）

    ==========================
func_a (6.243ms) : This is a comment for func_a
    └── func_b (5.116ms) : This is a comment for func_b
        └── func_c (3.055ms) : This is a comment for func_c

  • 出力 (ros2 topic echo /processing_time)

    ---
nodes:
- id: 1
  name: func_a
  processing_time: 6.366
  parent_id: 0
  comment: This is a comment for func_a
- id: 2
  name: func_b
  processing_time: 5.237
  parent_id: 1
  comment: This is a comment for func_b
- id: 3
  name: func_c
  processing_time: 3.156
  parent_id: 2
  comment: This is a comment for func_c

autoware::universe_utils::ScopedTimeTrack#

説明#

スコープ内の関数の処理時間を自動的に追跡するためのクラスです。

コンストラクタ#
ScopedTimeTrack(const std::string & func_name, TimeKeeper & time_keeper);
  • func_name: 追跡する関数の名前。
  • time_keeper: TimeKeeper オブジェクトへの参照。
デストラクター#
~ScopedTimeTrack();
  • ScopedTimeTrackオブジェクトを破壊し、関数の追跡を終了します。