1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Copyright 2017 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 SDF_ERROR_HH_
#define SDF_ERROR_HH_
#include <iostream>
#include <string>
#include "sdf/system_util.hh"
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::string
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
namespace sdf
{
/// \enum ErrorCode
/// \brief Set of error codes. Usually one or more errors are returned in
/// an Errors vector. The collection of Errors should be take as a whole,
/// where an error toward the beginning of the vector can inform errors
/// toward the end of the vector.
/// \sa Errors
enum class ErrorCode
{
// \brief No error
NONE = 0,
/// \brief Indicates that reading an SDF file failed.
FILE_READ,
/// \brief A duplicate name was found for an element where unique names
/// are required.
DUPLICATE_NAME,
/// \brief Indicates that a required SDF attribute is missing.
ATTRIBUTE_MISSING,
/// \brief This error indicates that an SDF attribute is invalid.
ATTRIBUTE_INVALID,
/// \brief This error indicates that an SDF attribute is deprecated.
ATTRIBUTE_DEPRECATED,
/// \brief Indicates that a required SDF element is missing.
ELEMENT_MISSING,
/// \brief This error indicates that an SDF element is invalid.
ELEMENT_INVALID,
/// \brief This error indicates that an SDF element is deprecated.
ELEMENT_DEPRECATED,
/// \brief Indicates that an incorrect SDF element type was
/// encountered. This error is used when an element of certain type is
/// expected, and an element of a different type was received.
ELEMENT_INCORRECT_TYPE,
/// \brief A URI is invalid.
URI_INVALID,
/// \brief A error occured while trying to resolve a URI.
URI_LOOKUP,
/// \brief A filesystem directory does not exist.
DIRECTORY_NONEXISTANT,
};
class SDFORMAT_VISIBLE Error
{
/// \brief default constructor
public: Error() = default;
/// \brief Constructor.
/// \param[in] _code The error code.
/// \param[in] _message A description of the error.
/// \sa ErrorCode.
public: Error(const ErrorCode _code, const std::string &_message);
/// \brief Get the error code.
/// \return An error code.
/// \sa ErrorCode.
public: ErrorCode Code() const;
/// \brief Get the error message, which is a description of the error.
/// \return Error message.
public: std::string Message() const;
/// \brief Safe bool conversion.
/// \return True if this Error's Code() != NONE. In otherwords, this is
/// true when there is an error.
public: explicit operator bool() const;
/// \brief Compare this Error to a boolean value.
/// \return True if the boolean evaluation of this Error equals _value.
/// If _value == false, then true is returned when this Error's Code() is
/// equal to NONE and false is returned otherwise. If _value == true,
/// then true is returned when this Error's Code() is not equal to NONE
/// and false is returned otherwise.
/// \sa explicit operator bool() const
public: bool operator==(const bool _value) const;
/// \brief Output operator for an error.
/// \param[in,out] _out The output stream.
/// \param[in] _err The error to output.
/// \return Reference to the given output stream
public: friend std::ostream &operator<<(std::ostream &_out,
const sdf::Error &_err)
{
_out << "Error Code "
<< static_cast<std::underlying_type<sdf::ErrorCode>::type>(_err.Code())
<< " Msg: " << _err.Message();
return _out;
}
/// \brief The error code value.
private: ErrorCode code = ErrorCode::NONE;
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::string
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
/// \brief Description of the error.
private: std::string message = "";
#ifdef _WIN32
#pragma warning(pop)
#endif
};
}
#ifdef _WIN32
#pragma warning(pop)
#endif
#endif
|
