Gazebo Transport

API Reference

13.4.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 
27 namespace gz
28 {
29  namespace transport
30  {
31  namespace parameters
32  {
33  // Inline bracket to help doxygen filtering.
34  inline namespace GZ_TRANSPORT_VERSION_NAMESPACE {
35 
38  {
39  Success,
44  Unexpected,
45  };
46 
51  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
52  explicit ParameterResult(ParameterResultType _resultType);
53 
57  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
59  ParameterResultType _resultType, const std::string & _paramName);
60 
65  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
67  ParameterResultType _resultType,
68  const std::string & _paramName,
69  const std::string & _paramType);
70 
72  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
74 
76  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
77  const std::string & ParamName() const;
78 
80  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
81  const std::string & ParamType() const;
82 
85  public: GZ_TRANSPORT_PARAMETERS_VISIBLE
86  explicit operator bool() const;
87 
88  private: ParameterResultType resultType;
89  private: std::string paramName;
90  private: std::string paramType;
91  };
92 
94  GZ_TRANSPORT_PARAMETERS_VISIBLE
96  }
97  }
98  }
99 }
100 
101 #endif