Gazebo Transport

API Reference

8.5.0
gz/transport/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 
27 namespace ignition
28 {
29  namespace transport
30  {
31  // Inline bracket to help doxygen filtering.
32  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
33  //
34  // Forward declarations.
35  class NodeOptionsPrivate;
36 
40  class IGNITION_TRANSPORT_VISIBLE NodeOptions
41  {
43  public: NodeOptions();
44 
47  public: NodeOptions(const NodeOptions &_other);
48 
50  public: virtual ~NodeOptions();
51 
55  public: NodeOptions &operator=(const NodeOptions &_other);
56 
60  public: const std::string &NameSpace() const;
61 
77  public: bool SetNameSpace(const std::string &_ns);
78 
82  public: const std::string &Partition() const;
83 
107  public: bool SetPartition(const std::string &_partition);
108 
117  public: bool AddTopicRemap(const std::string &_fromTopic,
118  const std::string &_toTopic);
119 
126  public: bool TopicRemap(const std::string &_fromTopic,
127  std::string &_toTopic) const;
128 
129 #ifdef _WIN32
130 // Disable warning C4251 which is triggered by
131 // std::unique_ptr
132 #pragma warning(push)
133 #pragma warning(disable: 4251)
134 #endif
138 #ifdef _WIN32
139 #pragma warning(pop)
140 #endif
141  };
142  }
143  }
144 }
145 #endif
std::unique_ptr< transport::NodeOptionsPrivate > dataPtr
Definition: gz/transport/NodeOptions.hh:137
const std::string & NameSpace() const
Get the namespace used in this node.
Definition: gz/transport/AdvertiseOptions.hh:28
STL class.
virtual ~NodeOptions()
Destructor.
bool AddTopicRemap(const std::string &_fromTopic, const std::string &_toTopic)
Add a new topic remapping. Any [Un]Advertise(), [Un]Subscribe() or Request() operation will check for...
NodeOptions & operator=(const NodeOptions &_other)
Assignment operator.
const std::string & Partition() const
Get the partition used in this node.
A class for customizing the behavior of the Node. E.g.: Set a custom namespace or a partition name.
Definition: gz/transport/NodeOptions.hh:40
bool TopicRemap(const std::string &_fromTopic, std::string &_toTopic) const
Get a topic remapping.
bool SetNameSpace(const std::string &_ns)
Set the node's namespace. A namespace is considered a prefix that might be potentially applied to som...
bool SetPartition(const std::string &_partition)
Set the node's partition name. A partition is used to isolate a set of topics or services from other ...