Public Member Functions | List of all members
sdf::v10::Error Class Reference

#include <Error.hh>

Public Member Functions

 Error ()=default
 default constructor More...
 
 Error (const ErrorCode _code, const std::string &_message)
 Constructor. More...
 
ErrorCode Code () const
 Get the error code. More...
 
std::string Message () const
 Get the error message, which is a description of the error. More...
 
 operator bool () const
 Safe bool conversion. More...
 
bool operator== (const bool _value) const
 Compare this Error to a boolean value. More...
 

Constructor & Destructor Documentation

◆ Error() [1/2]

sdf::v10::Error::Error ( )
default

default constructor

◆ Error() [2/2]

sdf::v10::Error::Error ( const ErrorCode  _code,
const std::string &  _message 
)

Constructor.

Parameters
[in]_codeThe error code.
[in]_messageA description of the error.
See also
ErrorCode.

Member Function Documentation

◆ Code()

ErrorCode sdf::v10::Error::Code ( ) const

Get the error code.

Returns
An error code.
See also
ErrorCode.

◆ Message()

std::string sdf::v10::Error::Message ( ) const

Get the error message, which is a description of the error.

Returns
Error message.

◆ operator bool()

sdf::v10::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::v10::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: