Face Engine SDK  5.31.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
FSDKError.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <fsdk/Types/Result.h>
11 
12 namespace fsdk {
13 
17  enum class FSDKError : uint32_t {
18  Ok,
19  Internal,
20  InvalidInput,
21  InvalidImage,
22 
23  InvalidRect,
24  InvalidImageFormat,
25  InvalidImageSize,
26  InvalidDetection,
27  InvalidLandmarks5,
28  InvalidLandmarks68,
29  InvalidTransformation,
30  InvalidDescriptor,
31  InvalidDescriptorBatch,
32  InvalidSettingsProvider,
33  InvalidDescriptorId,
34  InvalidPath,
35  InvalidSerializedObject,
36 
37  ModuleNotInitialized,
38  ModuleNotReady,
39  LicenseError,
40 
41  BufferIsNull,
42  BufferIsFull,
43  BufferIsEmpty,
44  InvalidBufferSize,
45  InvalidSpanSize,
46  InvalidBatch,
47 
48  IncompatibleDescriptors,
49  EnableJustInBetaMode,
50 
51  FiltredAggregationError,
52 
53  BatchedInternalError,
54  UnsupportedFunctionality, // !< was requested unsupported functionality for this type of descroptor or for
56  // this model version
57 
58  HighMemoryUsage, // !< Operation required a lot of memory. Batch size if too big for example.
59 
60  IncompatibleModelVersions,
61  ModelNotLoaded,
62  InvalidConfig,
63  LicenseIsNotActivated,
64  LicenseActivationLimitExceeded,
65  FeatureNotAvailable,
66  FeatureExpired,
67  FingerprintError,
68  FingerprintInternalMismatch,
69  ValidationFailed,
70  CudaError,
71 
72  NotImplemented,
73  };
74 
78  template <>
79  struct ErrorTraits<FSDKError> {
80 
81  static bool isOk(FSDKError error) noexcept {
82  return error == FSDKError::Ok;
83  }
84 
85  static const char* toString(FSDKError error) noexcept {
86  switch(error) {
87  case FSDKError::Ok:
88  return "Ok";
89  case FSDKError::Internal:
90  return "Internal error";
91  case FSDKError::InvalidInput:
92  return "Invalid input";
93  case FSDKError::InvalidImage:
94  return "Invalid image";
95  case FSDKError::InvalidRect:
96  return "Invalid rectangle";
97  case FSDKError::InvalidImageFormat:
98  return "Invalid image format";
99  case FSDKError::InvalidImageSize:
100  return "Invalid image size";
101  case FSDKError::InvalidDetection:
102  return "Invalid detection";
103  case FSDKError::InvalidLandmarks5:
104  return "Invalid landmarks 5";
105  case FSDKError::InvalidLandmarks68:
106  return "Invalid landmarks 68";
107  case FSDKError::InvalidTransformation:
108  return "Invalid transformation.";
109  case FSDKError::InvalidDescriptor:
110  return "Invalid descriptor";
111  case FSDKError::InvalidDescriptorBatch:
112  return "Invalid descriptor batch.";
113  case FSDKError::InvalidSettingsProvider:
114  return "Invalid settings provider..";
115  case FSDKError::InvalidDescriptorId:
116  return "Invalid descriptor id.";
117  case FSDKError::InvalidPath:
118  return "Invalid path.";
119  case FSDKError::InvalidSerializedObject:
120  return "Invalid serialized object.";
121  case FSDKError::ModuleNotInitialized:
122  return "Module is not initialized";
123  case FSDKError::ModuleNotReady:
124  return "Module is not ready";
125  case FSDKError::LicenseError:
126  return "Licensing issue";
127  case FSDKError::BufferIsNull:
128  return "Buffer is null";
129  case FSDKError::BufferIsFull:
130  return "Buffer is full";
131  case FSDKError::BufferIsEmpty:
132  return "Buffer is empty";
133  case FSDKError::InvalidBufferSize:
134  return "Invalid buffer size";
135  case FSDKError::InvalidSpanSize:
136  return "Invalid span size";
137  case FSDKError::InvalidBatch:
138  return "Invalid Batch";
139  case FSDKError::IncompatibleDescriptors:
140  return "Descriptors are incompatible";
141  case FSDKError::EnableJustInBetaMode:
142  return "Attempt to create feature while betaMode is turned off";
143  case FSDKError::FiltredAggregationError:
144  return "Cant aggregate descriptors - all images'a GSs are less the threashold";
145  case FSDKError::BatchedInternalError:
146  return "Something gone wrong in batched query";
147  case FSDKError::UnsupportedFunctionality:
148  return "Was requested unsupported functionality";
149  case FSDKError::HighMemoryUsage:
150  return "Operation required a lot of memory";
151  case FSDKError::IncompatibleModelVersions:
152  return "Incompatible model versions";
153  case FSDKError::ModelNotLoaded:
154  return "Model not loaded";
155  case FSDKError::InvalidConfig:
156  return "Invalid config";
157  case FSDKError::LicenseIsNotActivated:
158  return "License is not activated!";
159  case FSDKError::LicenseActivationLimitExceeded:
160  return "License activation limit exceeded.";
161  case FSDKError::FeatureNotAvailable:
162  return "Requested Feature not available.";
163  case FSDKError::FeatureExpired:
164  return "Feature is expired.";
165  case FSDKError::FingerprintError:
166  return "Failed to get device fingerprint.";
167  case FSDKError::FingerprintInternalMismatch:
168  return "Fingerprint mismatch.";
169  case FSDKError::ValidationFailed:
170  return "Failed validation.";
171  case FSDKError::CudaError:
172  return "CUDA Error";
173  case FSDKError::NotImplemented:
174  return "Not implemented.";
175  default:
176  return "Unknown error";
177  }
178  }
179  };
180 
181 } // namespace fsdk
fsdk::FSDKError::InvalidSerializedObject
Invalid serialized object.
fsdk::FSDKError::FiltredAggregationError
Cant aggregate descriptors - all images&#39;a GSs are less the threashold.
fsdk::FSDKError::IncompatibleDescriptors
Matching attempt with incompatible descriptors.
fsdk::FSDKError::NotImplemented
Not implemented error.
fsdk::FSDKError::InvalidDescriptorBatch
Invalid descriptor batch.
fsdk::FSDKError::InvalidSettingsProvider
Invalid settings provider.
fsdk::FSDKError::ModuleNotReady
Module is not ready.
fsdk::FSDKError::InvalidPath
Invalid path to object.
fsdk::ErrorTraits
Definition: Result.h:8
fsdk::FSDKError::FeatureNotAvailable
Requested Feature not available.
fsdk::FSDKError::LicenseActivationLimitExceeded
License activation limit exceeded.
fsdk::FSDKError::LicenseIsNotActivated
License is not activated.
fsdk::FSDKError::LicenseError
Licensing issue (expired license or unavailable feature).
fsdk::FSDKError::IncompatibleModelVersions
Incompatible model versions.
fsdk::FSDKError::ModuleNotInitialized
Module is not initialized.
fsdk::FSDKError
FSDKError
Common SDK error codes.
Definition: FSDKError.h:17
fsdk::FSDKError::InvalidRect
Invalid rectangle.
fsdk::FSDKError::EnableJustInBetaMode
Attempt to create feature while betaMode is turned off.
fsdk::FSDKError::FingerprintError
Failed to get device fingerprint.