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 <optional>
23 #include <gz/utils/ImplPtr.hh>
24 #include <sdf/sdf_config.h>
25 #include "sdf/system_util.hh"
26 
27 #ifdef _WIN32
28 // Disable warning C4251 which is triggered by
29 // std::string
30 #pragma warning(push)
31 #pragma warning(disable: 4251)
32 #endif
33 
34 namespace sdf
35 {
36  // Inline bracket to help doxygen filtering.
37  inline namespace SDF_VERSION_NAMESPACE {
38  //
39 
46  enum class ErrorCode
47  {
48  // \brief No error
49  NONE = 0,
50 
52  FILE_READ,
53 
57 
60 
63 
66 
69 
73 
76 
79 
82 
87 
90 
92  URI_LOOKUP,
93 
96 
99 
102 
105 
108 
111 
114 
117 
121 
124 
127 
131 
134 
137 
139  STRING_READ,
140 
143 
146 
150  };
151 
153  {
155  public: Error();
156 
161  public: Error(const ErrorCode _code, const std::string &_message);
162 
168  public: Error(const ErrorCode _code, const std::string &_message,
169  const std::string &_filePath);
170 
178  public: Error(const ErrorCode _code, const std::string &_message,
179  const std::string &_filePath, int _lineNumber);
180 
184  public: ErrorCode Code() const;
185 
188  public: std::string Message() const;
189 
193  public: std::optional<std::string> FilePath() const;
194 
198  public: void SetFilePath(const std::string &_filePath);
199 
202  public: std::optional<int> LineNumber() const;
203 
206  public: void SetLineNumber(int _lineNumber);
207 
211  public: std::optional<std::string> XmlPath() const;
212 
217  public: void SetXmlPath(const std::string &_xmlPath);
218 
222  public: explicit operator bool() const;
223 
231  public: bool operator==(const bool _value) const;
232 
237  public: friend SDFORMAT_VISIBLE std::ostream &operator<<(
238  std::ostream &_out, const sdf::Error &_err);
239 
241  IGN_UTILS_IMPL_PTR(dataPtr)
242  };
243  }
244 }
245 #ifdef _WIN32
246 #pragma warning(pop)
247 #endif
248 
249 
250 #endif
Definition: Error.hh:153
std::string Message() const
Get the error message, which is a description of the error.
std::optional< std::string > FilePath() const
Get the file path associated with this error.
Error(const ErrorCode _code, const std::string &_message, const std::string &_filePath, int _lineNumber)
Constructor.
bool operator==(const bool _value) const
Compare this Error to a boolean value.
std::optional< int > LineNumber() const
Get the line number associated with this error.
void SetLineNumber(int _lineNumber)
Sets the line number that is associated with this error.
ErrorCode Code() const
Get the error code.
void SetFilePath(const std::string &_filePath)
Sets the file path that is associated with this error.
Error()
Default constructor.
void SetXmlPath(const std::string &_xmlPath)
Safe bool conversion.
Error(const ErrorCode _code, const std::string &_message, const std::string &_filePath)
Constructor.
friend IGNITION_SDFORMAT_VISIBLE std::ostream & operator<<(std::ostream &_out, const sdf::Error &_err)
Output operator for an error.
std::optional< std::string > XmlPath() const
Get the XPath-like trace that is associated with this error.
Error(const ErrorCode _code, const std::string &_message)
Constructor.
ErrorCode
Set of error codes.
Definition: Error.hh:47
@ VERSION_DEPRECATED
The provided version has been deprecated or it is pre-versioning.
@ FRAME_ATTACHED_TO_CYCLE
The frame attached-to graph contains a cycle.
@ LINK_INERTIA_INVALID
A link has invalid inertia.
@ FRAME_ATTACHED_TO_GRAPH_ERROR
The frame attached-to graph has an internal error.
@ POSE_RELATIVE_TO_GRAPH_ERROR
The pose relative-to graph has an internal error.
@ ELEMENT_DEPRECATED
This error indicates that an SDF element is deprecated.
@ DUPLICATE_NAME
A duplicate name was found for an element where unique names are required.
@ JOINT_PARENT_LINK_INVALID
A joint has an invalid parent link.
@ ATTRIBUTE_INVALID
This error indicates that an SDF attribute is invalid.
@ URI_LOOKUP
A error occured while trying to resolve a URI.
@ ELEMENT_INVALID
This error indicates that an SDF element is invalid.
@ DIRECTORY_NONEXISTANT
A filesystem directory does not exist.
@ NESTED_MODELS_UNSUPPORTED
Indicates that a DOM object tried to read a nested model.
@ ELEMENT_MISSING
Indicates that a required SDF element is missing.
@ STRING_READ
Indicates that reading an SDF string failed.
@ FILE_READ
Indicates that reading an SDF file failed.
@ JOINT_CHILD_LINK_INVALID
A joint has an invalid child link.
@ JOINT_PARENT_SAME_AS_CHILD
A joint has the same link specified as parent and child.
@ ELEMENT_INCORRECT_TYPE
Indicates that an incorrect SDF element type was encountered.
@ MERGE_INCLUDE_UNSUPPORTED
Merge include is unspported for the type of entity being included, or the custom parser does not supp...
@ POSE_RELATIVE_TO_INVALID
The pose relative-to value does not match the name of an existing frame in the current scope.
@ MODEL_PLACEMENT_FRAME_INVALID
The specified placement frame is invalid.
@ ATTRIBUTE_DEPRECATED
This error indicates that an SDF attribute is deprecated.
@ FRAME_ATTACHED_TO_INVALID
The frame attached-to value does not match the name of an existing frame in the current scope.
@ POSE_RELATIVE_TO_CYCLE
The pose relative-to graph contains a cycle.
@ ATTRIBUTE_MISSING
Indicates that a required SDF attribute is missing.
@ MODEL_WITHOUT_LINK
A model without a link.
@ MODEL_CANONICAL_LINK_INVALID
A model with an invalid canonical link.
@ ATTRIBUTE_INCORRECT_TYPE
Indicates an attribute was included that is not part of the sdf spec.
@ RESERVED_NAME
A reserved name was used in an entity name attribute.
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25