![]() |
Murl Engine API
Version 2018.3
|
A class for retrieving the result of some operation. More...
#include <murl_result.h>
A class for retrieving the result of some operation.
Public Member Functions | |
Result () | |
The default constructor. | |
void | Clear () |
Clear the result (Set OK). | |
void | Set (const Result &other) |
Set a result from a given other result. More... | |
void | Append (const Result &other) |
Append a given other result. More... | |
void | Set (IEnums::ResultCode code, const Char *message,...) |
Set a result code and message. More... | |
void | Append (IEnums::ResultCode code, const Char *message,...) |
Append a result code and message. More... | |
Bool | IsClear () const |
Check if the contained result is OK. More... | |
Bool | HasInfo () const |
Check if the result contains at least one info. More... | |
UInt32 | GetNumberOfInfos () const |
Get the number of infos. More... | |
IEnums::ResultCode | GetInfoCode (UInt32 index) const |
Get the code of a info at a given index. More... | |
const String & | GetInfoMessage (UInt32 index) const |
Get the message of a info at a given index. More... | |
String | GetAllInfoMessages () const |
Get all info messages. More... | |
Bool | HasWarning () const |
Check if the result contains at least one warning. More... | |
UInt32 | GetNumberOfWarnings () const |
Get the number of warnings. More... | |
IEnums::ResultCode | GetWarningCode (UInt32 index) const |
Get the code of a warning at a given index. More... | |
const String & | GetWarningMessage (UInt32 index) const |
Get the message of a warning at a given index. More... | |
String | GetAllWarningMessages () const |
Get all warning messages. More... | |
Bool | HasError () const |
Check if the result contains at least one error. More... | |
UInt32 | GetNumberOfErrors () const |
Get the number of errors. More... | |
IEnums::ResultCode | GetErrorCode (UInt32 index) const |
Get the code of a error at a given index. More... | |
const String & | GetErrorMessage (UInt32 index) const |
Get the message of a error at a given index. More... | |
String | GetAllErrorMessages () const |
Get all error messages. More... | |
String | GetAllMessages () const |
Get all messages. More... | |
void Murl::Result::Set | ( | const Result & | other | ) |
Set a result from a given other result.
other | The result object to copy from. |
void Murl::Result::Append | ( | const Result & | other | ) |
Append a given other result.
other | The result object to copy from. |
void Murl::Result::Set | ( | IEnums::ResultCode | code, |
const Char * | message, | ||
... | |||
) |
Set a result code and message.
This clears the current result and sets a single message only.
code | The result code. |
message | The message. |
void Murl::Result::Append | ( | IEnums::ResultCode | code, |
const Char * | message, | ||
... | |||
) |
Append a result code and message.
code | The result code. |
message | The message. |
Bool Murl::Result::IsClear | ( | ) | const |
Check if the contained result is OK.
Bool Murl::Result::HasInfo | ( | ) | const |
Check if the result contains at least one info.
UInt32 Murl::Result::GetNumberOfInfos | ( | ) | const |
Get the number of infos.
IEnums::ResultCode Murl::Result::GetInfoCode | ( | UInt32 | index | ) | const |
Get the code of a info at a given index.
index | The info index, in the range [0..GetNumberOfInfos()-1]. |
Get the message of a info at a given index.
index | The info index, in the range [0..GetNumberOfInfos()-1]. |
String Murl::Result::GetAllInfoMessages | ( | ) | const |
Get all info messages.
This method concatenates all existing infos to one string, each one delimited by a single line feed character.
Bool Murl::Result::HasWarning | ( | ) | const |
Check if the result contains at least one warning.
UInt32 Murl::Result::GetNumberOfWarnings | ( | ) | const |
Get the number of warnings.
IEnums::ResultCode Murl::Result::GetWarningCode | ( | UInt32 | index | ) | const |
Get the code of a warning at a given index.
index | The warning index, in the range [0..GetNumberOfWarnings()-1]. |
Get the message of a warning at a given index.
index | The warning index, in the range [0..GetNumberOfWarnings()-1]. |
String Murl::Result::GetAllWarningMessages | ( | ) | const |
Get all warning messages.
This method concatenates all existing warnings to one string, each one delimited by a single line feed character.
Bool Murl::Result::HasError | ( | ) | const |
Check if the result contains at least one error.
UInt32 Murl::Result::GetNumberOfErrors | ( | ) | const |
Get the number of errors.
IEnums::ResultCode Murl::Result::GetErrorCode | ( | UInt32 | index | ) | const |
Get the code of a error at a given index.
index | The error index, in the range [0..GetNumberOfErrors()-1]. |
Get the message of a error at a given index.
index | The error index, in the range [0..GetNumberOfErrors()-1]. |
String Murl::Result::GetAllErrorMessages | ( | ) | const |
Get all error messages.
This method concatenates all existing errors to one string, each one delimited by a single line feed character.
String Murl::Result::GetAllMessages | ( | ) | const |
Get all messages.
This method concatenates all existing errors, warnings and infos to one string, each one delimited by a single line feed character.