Skip to content

Commit

Permalink
fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
john-maidbot committed Aug 12, 2023
1 parent 7661c82 commit 3146883
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 14 deletions.
15 changes: 10 additions & 5 deletions include/point_cloud_transport/point_cloud_codec.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
namespace point_cloud_transport
{

//! Class to expose all the functionality of pointcloud transport (encode/decode msgs) without needing to spin a node.
//! Class to expose all the functionality of pointcloud transport (encode/decode msgs)
//! without needing to spin a node.

class PointCloudCodec
{
Expand All @@ -59,15 +60,17 @@ class PointCloudCodec
//! Destructor
virtual ~PointCloudCodec();

/// \brief Get a shared pointer to an instance of a publisher plugin given its transport name (publishers encode messages).
/// \brief Get a shared pointer to an instance of a publisher plugin given its
/// transport name (publishers encode messages).
/// e.g. if you want the raw encoder, call getEncoderByName("raw").
///
/// \param name The name of the transport to load.
/// \returns A shared pointer to the publisher plugin.
std::shared_ptr<point_cloud_transport::PublisherPlugin> getEncoderByName(
const std::string & name);

/// \brief Get a shared pointer to an instance of a publisher plugin given its transport name (subscribers decode messages).
/// \brief Get a shared pointer to an instance of a publisher plugin given its transport name
/// (subscribers decode messages).
/// e.g. if you want the raw decoder, call getDecoderByName("raw").
///
/// \param name The name of the transport to load.
Expand All @@ -86,7 +89,8 @@ class PointCloudCodec
std::vector<std::string> & names);

///
/// \brief Get a list of all the transport plugins, topics, transport names, and their data types that can be loaded.
/// \brief Get a list of all the transport plugins, topics, transport names, and their data
/// types that can be loaded.
///
/// \param[in] baseTopic The base topic to use for the transport.
/// \param[out] transports Vector of the loadable transport plugins.
Expand All @@ -102,7 +106,8 @@ class PointCloudCodec
std::vector<std::string> & dataTypes);

///
/// \brief Get the topic, transport name, and data type that a given topic is published on for a particular transport plugin.
/// \brief Get the topic, transport name, and data type that a given topic is published on for a
/// particular transport plugin.
///
/// \param[in] baseTopic The base topic to use for the transport.
/// \param[in] transport The transport plugin to load.
Expand Down
3 changes: 2 additions & 1 deletion include/point_cloud_transport/publisher_plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ class POINT_CLOUD_TRANSPORT_PUBLIC PublisherPlugin

/// \brief Encode the given raw pointcloud into EncodeResult
/// \param[in] raw The input raw pointcloud.
/// \return The output EncodeResult holding the compressed cloud message (if encoding succeeds), or an error message.
/// \return The output EncodeResult holding the compressed cloud message (if encoding succeeds),
/// or an error message.
///
virtual EncodeResult encode(const sensor_msgs::msg::PointCloud2 & raw) const;

Expand Down
4 changes: 2 additions & 2 deletions include/point_cloud_transport/raw_subscriber.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ namespace point_cloud_transport
///
/// \brief The default SubscriberPlugin.
///
/// RawSubscriber is a simple wrapper for rclcpp::Subscription which listens for PointCloud2 messages
/// and passes them through to the callback.
/// RawSubscriber is a simple wrapper for rclcpp::Subscription which listens for
/// PointCloud2 messages and passes them through to the callback.
///
class RawSubscriber
: public point_cloud_transport::SimpleSubscriberPlugin<sensor_msgs::msg::PointCloud2>
Expand Down
2 changes: 1 addition & 1 deletion include/point_cloud_transport/subscriber_filter.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#include <memory>
#include <string>

#include <message_filters/simple_filter.h>
#include <message_filters/simple_filter.h> // NOLINT
#include <sensor_msgs/msg/point_cloud2.hpp>

#include <point_cloud_transport/point_cloud_transport.hpp>
Expand Down
6 changes: 4 additions & 2 deletions include/point_cloud_transport/subscriber_plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,8 @@ class POINT_CLOUD_TRANSPORT_PUBLIC SubscriberPlugin

///
/// \brief Decode the given compressed pointcloud into a raw cloud.
/// \param[in] compressed The rclcpp::SerializedMessage of the compressed pointcloud to be decoded.
/// \param[in] compressed The rclcpp::SerializedMessage of the compressed pointcloud
/// to be decoded.
/// \return The decoded raw pointcloud (if decoding succeeds), or an error message.
///
virtual DecodeResult decode(const std::shared_ptr<rclcpp::SerializedMessage> & compressed) const =
Expand Down Expand Up @@ -142,7 +143,8 @@ class POINT_CLOUD_TRANSPORT_PUBLIC SubscriberPlugin
///
/// \brief Get the name of the topic that this SubscriberPlugin will subscribe to.
/// \param[in] base_topic The topic that the subscriber was constructed with.
/// \return The name of the topic that this SubscriberPlugin will subscribe to (e.g. <base_topic>/<transport_name>).
/// \return The name of the topic that this SubscriberPlugin will subscribe to
/// (e.g. <base_topic>/<transport_name>).
virtual std::string getTopicToSubscribe(const std::string & base_topic) const = 0;

///
Expand Down
7 changes: 4 additions & 3 deletions test/test_message_filter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@

#include <gtest/gtest.h>

#include <string>
#include <memory>

#include <message_filters/subscriber.h>
#include <message_filters/sync_policies/approximate_time.h>
#include <message_filters/synchronizer.h>

#include <string>
#include <memory>

#include <rclcpp/rclcpp.hpp>

#include "point_cloud_transport/point_cloud_transport.hpp"
Expand Down

0 comments on commit 3146883

Please sign in to comment.