AddReferenceImageJobStatus.cs
3.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
using System;
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Represents the status of an <see cref="AddReferenceImageJobState"/>.
/// </summary>
/// <seealso cref="AddReferenceImageJobState.status"/>
/// <seealso cref="MutableRuntimeReferenceImageLibrary.ScheduleAddImageWithValidationJob"/>
public enum AddReferenceImageJobStatus
{
/// <summary>
/// No status, e.g., because the <see cref="AddReferenceImageJobState"/> was default-constructed.
/// </summary>
None,
/// <summary>
/// The job is pending.
/// </summary>
Pending,
/// <summary>
/// The reference image was added successfully.
/// </summary>
Success,
/// <summary>
/// The reference image was not added because it is invalid.
/// </summary>
ErrorInvalidImage,
/// <summary>
/// The reference image was not added due to an unknown error.
/// </summary>
ErrorUnknown,
}
/// <summary>
/// Extensions to the <see cref="AddReferenceImageJobStatus"/> `enum`.
/// </summary>
public static class AddReferenceImageJobStatusExtensions
{
/// <summary>
/// Determines whether the <see cref="AddReferenceImageJobStatus"/> is
/// <see cref="AddReferenceImageJobStatus.Pending"/>.
/// </summary>
/// <param name="status">The <see cref="AddReferenceImageJobStatus"/> being extended.</param>
/// <returns>Returns `true` if <paramref name="status"/> is <see cref="AddReferenceImageJobStatus.Pending"/>.
/// Returns `false` otherwise.</returns>
public static bool IsPending(this AddReferenceImageJobStatus status) =>
status == AddReferenceImageJobStatus.Pending;
/// <summary>
/// Determines whether the <see cref="AddReferenceImageJobStatus"/> has completed (successfully or not).
/// </summary>
/// <param name="status">The <see cref="AddReferenceImageJobStatus"/> being extended.</param>
/// <returns>Returns `true` if <paramref name="status"/> is greater than
/// <see cref="AddReferenceImageJobStatus.Pending"/>. Returns `false` otherwise.</returns>
public static bool IsComplete(this AddReferenceImageJobStatus status) =>
status > AddReferenceImageJobStatus.Pending;
/// <summary>
/// Determines whether the <see cref="AddReferenceImageJobStatus"/> has completed with an error.
/// </summary>
/// <param name="status">The <see cref="AddReferenceImageJobStatus"/> being extended.</param>
/// <returns>Returns `true` if <paramref name="status"/> is greater than or equal to
/// <see cref="AddReferenceImageJobStatus.ErrorInvalidImage"/>. Returns `false` otherwise.</returns>
public static bool IsError(this AddReferenceImageJobStatus status) =>
status >= AddReferenceImageJobStatus.ErrorInvalidImage;
/// <summary>
/// Determines whether the <see cref="AddReferenceImageJobStatus"/> has completed successfully.
/// </summary>
/// <param name="status">The <see cref="AddReferenceImageJobStatus"/> being extended.</param>
/// <returns>Returns `true` if <paramref name="status"/> is <see cref="AddReferenceImageJobStatus.Success"/>.
/// Returns `false` otherwise.</returns>
public static bool IsSuccess(this AddReferenceImageJobStatus status) =>
status == AddReferenceImageJobStatus.Success;
}
}