gz/transport/NodeOptions.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
 
#ifndef GZ_TRANSPORT_NODEOPTIONS_HH_
#define GZ_TRANSPORT_NODEOPTIONS_HH_
 
#include <memory>
#include <string>
 
#include "gz/transport/config.hh"
#include "gz/transport/Export.hh"
 
namespace ignition::transport
{
  // Inline bracket to help doxygen filtering.
  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
  //
  // Forward declarations.
  class NodeOptionsPrivate;
 
  class IGNITION_TRANSPORT_VISIBLE NodeOptions
  {
    public: NodeOptions();
 
    public: NodeOptions(const NodeOptions &_other);
 
    public: virtual ~NodeOptions();
 
    public: NodeOptions &operator=(const NodeOptions &_other);
 
    public: const std::string &NameSpace() const;
 
    public: bool SetNameSpace(const std::string &_ns);
 
    public: const std::string &Partition() const;
 
    public: bool SetPartition(const std::string &_partition);
 
    public: bool AddTopicRemap(const std::string &_fromTopic,
                               const std::string &_toTopic);
 
    public: bool TopicRemap(const std::string &_fromTopic,
                            std::string &_toTopic) const;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    protected: std::unique_ptr<transport::NodeOptionsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
  };
  }
}
#endif