Gazebo Transport

API Reference

14.1.0
result.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2022 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_PARAMETERS_EXCEPTIONS_HH_
19#define GZ_TRANSPORT_PARAMETERS_EXCEPTIONS_HH_
20
21#include <ostream>
22#include <string>
23
24#include "gz/transport/config.hh"
25#include "gz/transport/parameters/Export.hh"
26
27namespace gz::transport::parameters
28{
29 // Inline bracket to help doxygen filtering.
30 inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
31
42
47 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
48 explicit ParameterResult(ParameterResultType _resultType);
49
53 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
55 ParameterResultType _resultType, const std::string & _paramName);
56
61 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
63 ParameterResultType _resultType,
64 const std::string & _paramName,
65 const std::string & _paramType);
66
68 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
70
72 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
73 const std::string & ParamName() const;
74
76 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
77 const std::string & ParamType() const;
78
81 public: GZ_TRANSPORT_PARAMETERS_VISIBLE
82 explicit operator bool() const;
83
84 private: ParameterResultType resultType;
85 private: std::string paramName;
86 private: std::string paramType;
87 };
88
90 GZ_TRANSPORT_PARAMETERS_VISIBLE
92 }
93}
94
95#endif