Error.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2017 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 #ifndef SDF_ERROR_HH_
18 #define SDF_ERROR_HH_
19 
20 #include <iostream>
21 #include <string>
22 #include <sdf/sdf_config.h>
23 #include "sdf/system_util.hh"
24 
25 #ifdef _WIN32
26 // Disable warning C4251 which is triggered by
27 // std::string
28 #pragma warning(push)
29 #pragma warning(disable: 4251)
30 #endif
31 
32 namespace sdf
33 {
34  // Inline bracket to help doxygen filtering.
35  inline namespace SDF_VERSION_NAMESPACE {
36  //
37 
44  enum class ErrorCode
45  {
46  // \brief No error
47  NONE = 0,
48 
50  FILE_READ,
51 
55 
58 
61 
64 
67 
70 
73 
76 
81 
84 
86  URI_LOOKUP,
87 
90 
93 
96 
99 
102 
105 
108 
111 
115 
118 
121 
125 
128 
131 
133  STRING_READ,
134  };
135 
137  {
139  public: Error() = default;
140 
145  public: Error(const ErrorCode _code, const std::string &_message);
146 
150  public: ErrorCode Code() const;
151 
154  public: std::string Message() const;
155 
159  public: explicit operator bool() const;
160 
168  public: bool operator==(const bool _value) const;
169 
174  public: friend std::ostream &operator<<(std::ostream &_out,
175  const sdf::Error &_err)
176  {
177  _out << "Error Code "
178  << static_cast<std::underlying_type<sdf::ErrorCode>::type>(_err.Code())
179  << " Msg: " << _err.Message();
180  return _out;
181  }
182 
184  private: ErrorCode code = ErrorCode::NONE;
185 
186 #ifdef _WIN32
187  // Disable warning C4251 which is triggered by
188  // std::string
189  #pragma warning(push)
190  #pragma warning(disable: 4251)
191 #endif
192  private: std::string message = "";
194 #ifdef _WIN32
195  #pragma warning(pop)
196 #endif
197  };
198  }
199 }
200 #ifdef _WIN32
201 #pragma warning(pop)
202 #endif
203 
204 
205 #endif
Indicates that a required SDF attribute is missing.
Indicates that a required SDF element is missing.
A reserved name was used in an entity name attribute.
This error indicates that an SDF element is invalid.
Indicates that an incorrect SDF element type was encountered.
The pose relative-to graph contains a cycle.
Indicates that reading an SDF string failed.
ErrorCode
Set of error codes.
Definition: Error.hh:44
This error indicates that an SDF attribute is deprecated.
A filesystem directory does not exist.
A error occured while trying to resolve a URI.
The frame attached-to graph has an internal error.
The pose relative-to graph has an internal error.
A model with an invalid canonical link.
The frame attached-to graph contains a cycle.
Definition: Error.hh:136
The frame attached-to value does not match the name of an existing frame in the current scope...
A joint has an invalid child link.
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
A duplicate name was found for an element where unique names are required.
friend std::ostream & operator<<(std::ostream &_out, const sdf::Error &_err)
Output operator for an error.
Definition: Error.hh:174
A link has invalid inertia.
This error indicates that an SDF element is deprecated.
Indicates that reading an SDF file failed.
namespace for Simulation Description Format parser
Definition: Actor.hh:32
This error indicates that an SDF attribute is invalid.
A joint has the same link specified as parent and child.
A joint has an invalid parent link.
The pose relative-to value does not match the name of an existing frame in the current scope...
Indicates that a DOM object tried to read a nested model.