![]() |
Apparatus
Version 1.21
ECS data-oriented workflow for Unreal Engine.
|
The Apparatus status reporting facility. More...
#include "CoreMinimal.h"
#include "UObject/Class.h"
#include "ApparatusRuntime.h"
#include "ApparatusStatus.generated.h"
Classes | |
class | FApparatusDelegates |
The main core-level Apparatus delegates. More... | |
Macros | |
#define | APPARATUS_STRINGIFY(symbol) #symbol |
Stringify a symbol. More... | |
#define | iAPPARATUS_REPORT_POSITIVE(Format, ...) |
#define | APPARATUS_REPORT(Status, Format, ...) |
Report a status with a formatted message. More... | |
#define | APPARATUS_REPEAT_REPORT(Status, Format, ...) |
Repeat the report got from a previously called function. More... | |
#define | APPARATUS_REPORT_SUCCESS(Format, ...) |
Report a success status with a formatted message. More... | |
Enumerations | |
enum class | EApparatusStatus : uint8 { None = 0 , Success = 128 , Noop = Success | 1 , Blank = Success | 2 , DeferredSuccess = Success | 3 , Error = 16 , InvalidArgument = Error + 1 , NullArgument = Error + 2 , OutOfRange = Error + 3 , NotAvailable = Error + 4 , NotFound = Error + 5 , InvalidOperation = Error + 6 , InvalidState = Error + 7 , UnsupportedOperation = Error + 8 , Conflict = Error + 9 , NoPermission = Error + 10 , OutOfLimit = Error + 11 , NoMemory = Error + 12 , FatalError = Error + 13 , CompletedWithIssue = Success | Error , CompletedWithInvalidArgument = Success | InvalidArgument , CompletedWithNullArgument = Success | NullArgument , CompletedWithOutOfRange = Success | OutOfRange , CompletedWithNotAvailable = Success | NotAvailable , CompletedWithNotFound = Success | NotFound , CompletedWithInvalidOperation = Success | InvalidOperation , CompletedWithInvalidState = Success | InvalidState , CompletedWithUnsupportedOperation = Success | UnsupportedOperation , CompletedWithConflict = Success | Conflict , CompletedWithNoPermission = Success | NoPermission , CompletedWithOutOfLimit = Success | OutOfLimit , CompletedWithNoMemory = Success | NoMemory } |
The general Apparatus operation status type. More... | |
Functions | |
bool | OK (const EApparatusStatus Status) |
Check if the status is a successful one. More... | |
EApparatusStatus | ExtractError (const EApparatusStatus Status) |
Extract an error from a status. More... | |
EApparatusStatus | StatusCombine (const EApparatusStatus A, const EApparatusStatus B) |
Combine two statuses deriving a new one based on them. More... | |
template<size_t N> | |
EApparatusStatus | StatusCombine (const EApparatusStatus(&Statuses)[N]) |
Combine several statuses deriving a new one based on them. More... | |
template<typename ... Ts> | |
EApparatusStatus | StatusCombine (const Ts... Statuses) |
Combine several statuses deriving a new one based on them. More... | |
EApparatusStatus | StatusAccumulate (EApparatusStatus &A, const EApparatusStatus B) |
Accumulate a status with another status to the first operaad. More... | |
template<size_t N> | |
EApparatusStatus | StatusAccumulate (EApparatusStatus &Status, const EApparatusStatus(&Statuses)[N]) |
Accumulate several statuses deriving a new one based on them. More... | |
template<typename ... Ts> | |
EApparatusStatus | StatusAccumulate (EApparatusStatus &Status, const Ts... Statuses) |
Accumulate several statuses deriving a new one based on them. More... | |
UEnum * | GetApparatusStatusClass () |
Get the Apparatus status class. More... | |
FString | ToString (const EApparatusStatus Status) |
Convert an apparatus status variable to a string representation. More... | |
EApparatusStatus | Report (const EApparatusStatus Status, const TCHAR *InMessage) |
Report a status along with a message. More... | |
EApparatusStatus | Report (const EApparatusStatus Status, const TCHAR *InFormatString, const FStringFormatOrderedArguments &InOrderedArguments) |
Report a status with a formatted message. More... | |
EApparatusStatus | Report (const EApparatusStatus Status, const TCHAR *InFormatString, const FStringFormatNamedArguments &InNamedArguments) |
Report a status with a formatted message. More... | |
template<EApparatusStatus Status> | |
EApparatusStatus | Report (const TCHAR *InMessage) |
Report a status along with a message. More... | |
template<EApparatusStatus Status> | |
EApparatusStatus | Report (const TCHAR *InFormatString, const FStringFormatOrderedArguments &InOrderedArguments) |
Report a status with a formatted message. More... | |
template<EApparatusStatus Status> | |
EApparatusStatus | Report (const TCHAR *InFormatString, const FStringFormatNamedArguments &InNamedArguments) |
Report a status with a formatted message. More... | |
The Apparatus status reporting facility.
#define APPARATUS_REPEAT_REPORT | ( | Status, | |
Format, | |||
... | |||
) |
Repeat the report got from a previously called function.
#define APPARATUS_REPORT | ( | Status, | |
Format, | |||
... | |||
) |
Report a status with a formatted message.
Status | The status to report but without the EApparatusStatus:: prefix. |
Format | The format string to report with. |
... | The arguments to use within the format string. |
#define APPARATUS_REPORT_SUCCESS | ( | Format, | |
... | |||
) |
Report a success status with a formatted message.
#define APPARATUS_STRINGIFY | ( | symbol | ) | #symbol |
Stringify a symbol.
#define iAPPARATUS_REPORT_POSITIVE | ( | Format, | |
... | |||
) |
|
strong |
The general Apparatus operation status type.
Apparatus uses its own status reporting mechanism where applicable. Values greater than or equal to EApparatusStatus::Success are variations of success, lesser than - are errors.
|
inline |
Extract an error from a status.
|
inline |
Get the Apparatus status class.
|
inline |
Check if the status is a successful one.
|
inline |
Report a status with a formatted message.
Status | The status to report. |
InFormatString | The format string to report with. Example: "{foo}/{bar}: {baz}" |
InNamedArguments | The arguments to use within the format string. |
|
inline |
Report a status with a formatted message.
Status | The status to report. |
InFormatString | The format string to report with. Example: "{0}/{1}: {2}" |
InOrderedArguments | The arguments to use within the format string. |
|
inline |
Report a status along with a message.
Status | The status to report. |
InMessage | The message to report along with the status. |
|
inline |
Report a status with a formatted message.
Templated version.
Status | The status to report. |
InFormatString | The format string to report with. Example: "{foo}/{bar}: {baz}" |
InNamedArguments | The arguments to use within the format string. |
|
inline |
Report a status with a formatted message.
Templated version.
Status | The status to report. |
InFormatString | The format string to report with. Example: "{0}/{1}: {2}" |
InOrderedArguments | The arguments to use within the format string. |
|
inline |
Report a status along with a message.
Templated version.
Status | The status to report. |
InMessage | The message to report along with the status. |
|
inline |
Accumulate a status with another status to the first operaad.
|
inline |
Accumulate several statuses deriving a new one based on them.
|
inline |
Accumulate several statuses deriving a new one based on them.
Be warned the the order of evaluation for function arguments is not explicitly defined or guaranteed in C++.
|
inline |
Combine two statuses deriving a new one based on them.
Be warned the the order of evaluation for function arguments is not explicitly defined or guaranteed in C++.
|
inline |
Combine several statuses deriving a new one based on them.
|
inline |
Combine several statuses deriving a new one based on them.
Be warned the the order of evaluation for function arguments is not explicitly defined or guaranteed in C++.
|
inline |
Convert an apparatus status variable to a string representation.