Result Class Reference
Class describing a result of an operation. More...
#include <Result.hh>
Public Member Functions | |
| Result () | |
| Default constructor. More... | |
| Result (const Result &_result) | |
| Copy constructor. More... | |
| Result (const ResultType _type) | |
| Constructor. More... | |
| Result (Result &&_result) noexcept | |
| Move constructor. More... | |
| virtual | ~Result () |
| Destructor. More... | |
| virtual | operator bool () const |
| Operator bool returns true if operation was successful. More... | |
| Result & | operator= (const Result &_result) |
| Copy assignment operator. More... | |
| Result & | operator= (Result &&_result) noexcept |
| Move assignment operator. More... | |
| virtual std::string | ReadableResult () const |
| Get human readable result string. More... | |
| ResultType | Type () const |
| Get the type of result. More... | |
Detailed Description
Class describing a result of an operation.
Constructor & Destructor Documentation
🔗Result() [1/4]
| Result | ( | ) |
Default constructor.
🔗~Result()
|
virtual |
Destructor.
🔗Result() [2/4]
|
explicit |
Constructor.
- Parameters
-
[in] _type Result type
🔗Result() [3/4]
🔗Result() [4/4]
Member Function Documentation
🔗operator bool()
|
virtual |
Operator bool returns true if operation was successful.
- Returns
- True if the operation was successful.
🔗operator=() [1/2]
Copy assignment operator.
- Parameters
-
[in] _result Result to copy.
🔗operator=() [2/2]
🔗ReadableResult()
|
virtual |
Get human readable result string.
- Returns
- The result string.
🔗Type()
| ResultType Type | ( | ) | const |
Get the type of result.
- Returns
- The type of result.
The documentation for this class was generated from the following file: