gz/transport/parameters/result.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_EXCEPTIONS_HH_
#define GZ_TRANSPORT_PARAMETERS_EXCEPTIONS_HH_
 
#include <ostream>
#include <string>
 
#include "gz/transport/config.hh"
#include "gz/transport/parameters/Export.hh"
 
namespace ignition::transport::parameters
{
  // Inline bracket to help doxygen filtering.
  inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
    enum class IGNITION_TRANSPORT_PARAMETERS_VISIBLE
    ParameterResultType {
      Success,
      AlreadyDeclared,
      InvalidType,
      NotDeclared,
      ClientTimeout,
      Unexpected,
    };
 
    class ParameterResult {
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      explicit ParameterResult(ParameterResultType _resultType);
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      ParameterResult(
        ParameterResultType _resultType, const std::string & _paramName);
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      ParameterResult(
        ParameterResultType _resultType,
        const std::string & _paramName,
        const std::string & _paramType);
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      ParameterResultType ResultType() const;
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      const std::string & ParamName() const;
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      const std::string & ParamType() const;
 
      public: IGNITION_TRANSPORT_PARAMETERS_VISIBLE
      explicit operator bool() const;
 
      private: ParameterResultType resultType;
      private: std::string paramName;
      private: std::string paramType;
    };
 
    IGNITION_TRANSPORT_PARAMETERS_VISIBLE
    std::ostream & operator<<(std::ostream &, const ParameterResult &);
  }
}
 
#endif