#include <Error.hh>
|
| Error ()=default |
| default constructor
|
| Error (const ErrorCode _code, const std::string &_message) |
| Constructor.
|
ErrorCode | Code () const |
| Get the error code.
|
std::string | Message () const |
| Get the error message, which is a description of the error.
|
| operator bool () const |
| Safe bool conversion.
|
bool | operator== (const bool _value) const |
| Compare this Error to a boolean value.
|
◆ Error() [1/2]
◆ Error() [2/2]
sdf::Error::Error |
( |
const ErrorCode | _code, |
|
|
const std::string & | _message ) |
Constructor.
- Parameters
-
[in] | _code | The error code. |
[in] | _message | A description of the error. |
- See also
- ErrorCode.
◆ Code()
◆ Message()
std::string sdf::Error::Message |
( |
| ) |
const |
Get the error message, which is a description of the error.
- Returns
- Error message.
Referenced by operator<<.
◆ operator bool()
sdf::Error::operator bool |
( |
| ) |
const |
|
explicit |
Safe bool conversion.
- Returns
- True if this Error's Code() != NONE. In otherwords, this is true when there is an error.
◆ operator==()
bool sdf::Error::operator== |
( |
const bool | _value | ) |
const |
Compare this Error to a boolean value.
- Returns
- 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.
- See also
- explicit operator bool() const
The documentation for this class was generated from the following file: