gz/transport/parameters/Client.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2022 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_PARAMETERS_CLIENT_HH_
#define GZ_TRANSPORT_PARAMETERS_CLIENT_HH_
 
#include <memory>
#include <string>
 
#include "google/protobuf/message.h"
 
#include "ignition/msgs/parameter_declarations.pb.h"
 
#include "gz/transport/config.hh"
#include "gz/transport/Node.hh"
#include "gz/transport/parameters/Export.hh"
#include "gz/transport/parameters/Interface.hh"
 
namespace ignition::transport::parameters
{
  // Inline bracket to help doxygen filtering.
  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
 
  struct ParametersClientPrivate;
 
  class IGNITION_TRANSPORT_PARAMETERS_VISIBLE ParametersClient
  : public ParametersInterface
  {
    public: ParametersClient(
      const std::string & _serverNamespace = "",
      unsigned int _timeoutMs = kDefaultTimeoutMs);
 
    public: ~ParametersClient();
 
    public: ParametersClient(const ParametersClient &) = delete;
    public: ParametersClient & operator=(const ParametersClient &) = delete;
    public: ParametersClient(ParametersClient &&);
    public: ParametersClient & operator=(ParametersClient &&);
 
    public: ParameterResult DeclareParameter(
      const std::string & _parameterName,
      const google::protobuf::Message & _msg) final;
 
    public: ParameterResult Parameter(
      const std::string & _parameterName,
      google::protobuf::Message & _parameter) const final;
 
    public: ParameterResult Parameter(
      const std::string & _parameterName,
      std::unique_ptr<google::protobuf::Message> & _parameter) const final;
 
    public: ParameterResult SetParameter(
        const std::string & _parameterName,
        const google::protobuf::Message & _msg) final;
 
    public: ignition::msgs::ParameterDeclarations ListParameters() const final;
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    private: std::unique_ptr<ParametersClientPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
 
    private: constexpr static inline unsigned int kDefaultTimeoutMs = 5000;
  };
  }
}
 
#endif