Gazebo Transport

API Reference

14.1.0
SubscribeOptions.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2016 Open Source Robotics Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16*/
17
18#ifndef GZ_TRANSPORT_SUBSCRIBEOPTIONS_HH_
19#define GZ_TRANSPORT_SUBSCRIBEOPTIONS_HH_
20
21#include <cstdint>
22#include <memory>
23
24#include "gz/transport/config.hh"
25#include "gz/transport/Export.hh"
26
27namespace gz::transport
28{
29 // Inline bracket to help doxygen filtering.
30 inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
31 //
32 class SubscribeOptionsPrivate;
33
37 class GZ_TRANSPORT_VISIBLE SubscribeOptions
38 {
41
44 public: SubscribeOptions(const SubscribeOptions &_otherSubscribeOpts);
45
48
53 public: bool Throttled() const;
54
60 public: void SetMsgsPerSec(const uint64_t _newMsgsPerSec);
61
65 public: uint64_t MsgsPerSec() const;
66
71 public: void SetIgnoreLocalMessages(bool _ignore);
72
77 public: bool IgnoreLocalMessages() const;
78
79#ifdef _WIN32
80// Disable warning C4251 which is triggered by
81// std::unique_ptr
82#pragma warning(push)
83#pragma warning(disable: 4251)
84#endif
88#ifdef _WIN32
89#pragma warning(pop)
90#endif
91 };
92 }
93}
94#endif