Gazebo Transport

API Reference

14.1.0
NodeOptions.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2015 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_NODEOPTIONS_HH_
19#define GZ_TRANSPORT_NODEOPTIONS_HH_
20
21#include <memory>
22#include <string>
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 // Forward declarations.
33 class NodeOptionsPrivate;
34
38 class GZ_TRANSPORT_VISIBLE NodeOptions
39 {
41 public: NodeOptions();
42
45 public: NodeOptions(const NodeOptions &_other);
46
48 public: virtual ~NodeOptions();
49
53 public: NodeOptions &operator=(const NodeOptions &_other);
54
58 public: const std::string &NameSpace() const;
59
75 public: bool SetNameSpace(const std::string &_ns);
76
80 public: const std::string &Partition() const;
81
105 public: bool SetPartition(const std::string &_partition);
106
115 public: bool AddTopicRemap(const std::string &_fromTopic,
116 const std::string &_toTopic);
117
124 public: bool TopicRemap(const std::string &_fromTopic,
125 std::string &_toTopic) const;
126
127#ifdef _WIN32
128// Disable warning C4251 which is triggered by
129// std::unique_ptr
130#pragma warning(push)
131#pragma warning(disable: 4251)
132#endif
136#ifdef _WIN32
137#pragma warning(pop)
138#endif
139 };
140 }
141}
142#endif