Ignition Transport

API Reference

4.0.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 IGN_TRANSPORT_NODEOPTIONS_HH_
19 #define IGN_TRANSPORT_NODEOPTIONS_HH_
20 
21 #include <memory>
22 #include <string>
23 
24 #include "ignition/transport/Export.hh"
25 
26 namespace ignition
27 {
28  namespace transport
29  {
30  class NodeOptionsPrivate;
31 
35  class IGNITION_TRANSPORT_VISIBLE NodeOptions
36  {
38  public: NodeOptions();
39 
42  public: NodeOptions(const NodeOptions &_other);
43 
45  public: virtual ~NodeOptions();
46 
50  public: NodeOptions &operator=(const NodeOptions &_other);
51 
55  public: const std::string &NameSpace() const;
56 
72  public: bool SetNameSpace(const std::string &_ns);
73 
77  public: const std::string &Partition() const;
78 
102  public: bool SetPartition(const std::string &_partition);
103 
107  };
108  }
109 }
110 #endif
A class for customizing the behavior of the Node. E.g.: Set a custom namespace or a partition name.
Definition: NodeOptions.hh:36
const std::string & Partition() const
Get the partition used in this node.
NodeOptions & operator=(const NodeOptions &_other)
Assignment operator.
const std::string & NameSpace() const
Get the namespace used in this node.
std::unique_ptr< transport::NodeOptionsPrivate > dataPtr
Definition: NodeOptions.hh:106
virtual ~NodeOptions()
Destructor.
bool SetNameSpace(const std::string &_ns)
Set the node's namespace. A namespace is considered a prefix that might be potentially applied to som...
NodeOptions(const NodeOptions &_other)
Copy constructor.
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 ...
Definition: AdvertiseOptions.hh:28