NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
sdk_results_enum.h
Go to the documentation of this file.
1 #ifndef SDK_SDK_RESULTS_ENUM_H_
11 #define SDK_SDK_RESULTS_ENUM_H_
12 
13 #include "base/inc/sdk_results.h"
14 
15 // #if defined(__cplusplus)
16 
17 namespace sdk {
18 
21  typedef enum ErrorCodes {
28  Err_NotImpl = kSDKResult_NotImplemented,
54  } ErrorCodes;
55 
56  typedef SDKResult Result;
57 
58 } // namespace sdk
59 // #endif
60 
63 
65 #define SDK_OK(res) ((static_cast<SDKResult>(res)) == kSDKResult_Succeeded)
66 #define SDK_SUCCEEDED(res) ((static_cast<SDKResult>(res)) >= 0)
68 #define SDK_FAILED(res) ((static_cast<SDKResult>(res)) != kSDKResult_Succeeded) // ((static_cast<SDKResult>(res)) < 0)
70 #define SDK_TRUE(res) ((static_cast<SDKResult>(res)) == kSDKResult_True)
72 #define SDK_FALSE(res) ((static_cast<SDKResult>(res)) == kSDKResult_False)
74 #define SDK_ERROR(res) ((static_cast<SDKResult>(res)) & kSDKResult_Error)
75 
77 
78 #endif // SDK_SDK_RESULTS_ENUM_H_
sdk::Err_NotFound
@ Err_NotFound
Requested item is not found.
Definition: sdk_results_enum.h:40
sdk::Err_NotEnoughParameters
@ Err_NotEnoughParameters
Not enough parameters.
Definition: sdk_results_enum.h:50
kSDKResult_NotEnoughParameters
static const SDKResult kSDKResult_NotEnoughParameters
Not enough parameters.
Definition: sdk_results.h:132
kSDKResult_UnexpectedError
static const SDKResult kSDKResult_UnexpectedError
Unexpected error occurred during operation.
Definition: sdk_results.h:46
sdk::Err_AlreadyExist
@ Err_AlreadyExist
An object already exists.
Definition: sdk_results_enum.h:47
sdk_results.h
A list of SDK error/return results.
sdk::Err_NULLPointer
@ Err_NULLPointer
Null pointer passed.
Definition: sdk_results_enum.h:38
kSDKResult_BadType
static const SDKResult kSDKResult_BadType
Something has wrong type.
Definition: sdk_results.h:100
kSDKResult_AccessDenied
static const SDKResult kSDKResult_AccessDenied
Generic access denied.
Definition: sdk_results.h:129
kSDKResult_Stopped
static const SDKResult kSDKResult_Stopped
Process was stopped.
Definition: sdk_results.h:40
sdk::Err_CompressionError
@ Err_CompressionError
Compression error.
Definition: sdk_results_enum.h:46
kSDKResult_AlreadyInitialized
static const SDKResult kSDKResult_AlreadyInitialized
Something is already initialized.
Definition: sdk_results.h:126
sdk::Err_EOF
@ Err_EOF
End of file is reached.
Definition: sdk_results_enum.h:25
sdk::Err_EmptyValue
@ Err_EmptyValue
An empty value.
Definition: sdk_results_enum.h:48
sdk::Err_CryptError
@ Err_CryptError
General encryption error.
Definition: sdk_results_enum.h:45
kSDKResult_NotEnoughMemory
static const SDKResult kSDKResult_NotEnoughMemory
Not enough memory for an operation.
Definition: sdk_results.h:61
kSDKResult_InternalError
static const SDKResult kSDKResult_InternalError
Internal error occurred.
Definition: sdk_results.h:52
sdk::Err_NotSupported
@ Err_NotSupported
Not supported.
Definition: sdk_results_enum.h:33
kSDKResult_Succeeded
static const SDKResult kSDKResult_Succeeded
Operation completed successfully.
Definition: sdk_results.h:22
sdk::Err_True
@ Err_True
Operation completed successfully with true result.
Definition: sdk_results_enum.h:23
sdk::Err_NotApplicable
@ Err_NotApplicable
A function is not applicable for the object.
Definition: sdk_results_enum.h:37
kSDKResult_CantLoadData
static const SDKResult kSDKResult_CantLoadData
A data could not be loaded.
Definition: sdk_results.h:115
sdk::Ok
@ Ok
Operation completed successfully.
Definition: sdk_results_enum.h:22
sdk::Err_Uninitialized
@ Err_Uninitialized
Not initialized object.
Definition: sdk_results_enum.h:30
kSDKResult_EmptyValue
static const SDKResult kSDKResult_EmptyValue
Value is empty or absent.
Definition: sdk_results.h:34
kSDKResult_NotSupported
static const SDKResult kSDKResult_NotSupported
Not supported.
Definition: sdk_results.h:67
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
kSDKResult_UnknownError
static const SDKResult kSDKResult_UnknownError
Unknown error occurred during operation.
Definition: sdk_results.h:49
sdk::Err_InvalidArg
@ Err_InvalidArg
Wrong argument passed to function.
Definition: sdk_results_enum.h:27
sdk::Err_NotEnoughMemory
@ Err_NotEnoughMemory
Not enough memory.
Definition: sdk_results_enum.h:53
kSDKResult_NotOpened
static const SDKResult kSDKResult_NotOpened
Work with not opened source.
Definition: sdk_results.h:85
sdk::Err_NotOpened
@ Err_NotOpened
A source is not opened.
Definition: sdk_results_enum.h:41
sdk::Err_Unexpected
@ Err_Unexpected
Not implemented.
Definition: sdk_results_enum.h:29
sdk::Err_UnknownError
@ Err_UnknownError
Unknown error.
Definition: sdk_results_enum.h:52
kSDKResult_EOFReached
static const SDKResult kSDKResult_EOFReached
End of file is reached.
Definition: sdk_results.h:31
kSDKResult_ReadOnly
static const SDKResult kSDKResult_ReadOnly
Trying to open read-only for editing.
Definition: sdk_results.h:112
kSDKResult_NotInitialized
static const SDKResult kSDKResult_NotInitialized
Not initialized.
Definition: sdk_results.h:64
sdk::Err_False
@ Err_False
Operation completed successfully with false result.
Definition: sdk_results_enum.h:24
kSDKResult_NotApplicable
static const SDKResult kSDKResult_NotApplicable
Used to indicate when information is not provided, either because it does not apply to a particular c...
Definition: sdk_results.h:123
sdk::Err_OutOfRange
@ Err_OutOfRange
A value is out of range
Definition: sdk_results_enum.h:44
sdk::Err_BufferTooSmall
@ Err_BufferTooSmall
Buffer is too small.
Definition: sdk_results_enum.h:35
sdk::Err_CantPerformAction
@ Err_CantPerformAction
Failed to perform an action.
Definition: sdk_results_enum.h:43
kSDKResult_CantPerformAction
static const SDKResult kSDKResult_CantPerformAction
Operation can't be performed.
Definition: sdk_results.h:73
sdk::Err_InternalError
@ Err_InternalError
Internal error.
Definition: sdk_results_enum.h:36
sdk::Err_Stopped
@ Err_Stopped
Operation stopped.
Definition: sdk_results_enum.h:51
sdk::Err_AccessDenied
@ Err_AccessDenied
Access denied.
Definition: sdk_results_enum.h:49
kSDKResult_OutOfRange
static const SDKResult kSDKResult_OutOfRange
Out of range request.
Definition: sdk_results.h:109
sdk::Err_ReadOnly
@ Err_ReadOnly
Read only object.
Definition: sdk_results_enum.h:42
kSDKResult_NotFound
static const SDKResult kSDKResult_NotFound
Something is not found.
Definition: sdk_results.h:76
kSDKResult_CompressionError
static const SDKResult kSDKResult_CompressionError
Compression or decompression has failed.
Definition: sdk_results.h:106
sdk::Err_NotExist
@ Err_NotExist
Not exist.
Definition: sdk_results_enum.h:26
sdk::Err_BadType
@ Err_BadType
Bad type.
Definition: sdk_results_enum.h:34
kSDKResult_AlreadyExist
static const SDKResult kSDKResult_AlreadyExist
Something is exist already.
Definition: sdk_results.h:37
kSDKResult_CryptError
static const SDKResult kSDKResult_CryptError
Encryption or decryption has failed.
Definition: sdk_results.h:103
kSDKResult_BadFormat
static const SDKResult kSDKResult_BadFormat
Something has wrong format.
Definition: sdk_results.h:97
kSDKResult_NotExist
static const SDKResult kSDKResult_NotExist
Something does not exist.
Definition: sdk_results.h:79
kSDKResult_True
static const SDKResult kSDKResult_True
Operation completed successfully with true result.
Definition: sdk_results.h:25
kSDKResult_NotImplemented
static const SDKResult kSDKResult_NotImplemented
Not implemented.
Definition: sdk_results.h:70
sdk::Err_BadFormat
@ Err_BadFormat
Bad format.
Definition: sdk_results_enum.h:32
sdk::Err_CantLoadData
@ Err_CantLoadData
Failed to load data.
Definition: sdk_results_enum.h:31
kSDKResult_InvalidArgument
static const SDKResult kSDKResult_InvalidArgument
Wrong argument passed to function.
Definition: sdk_results.h:55
sdk::Err_AlreadyInitialized
@ Err_AlreadyInitialized
An object is already initialized.
Definition: sdk_results_enum.h:39
kSDKResult_NULLPointer
static const SDKResult kSDKResult_NULLPointer
NULL pointer passed to function.
Definition: sdk_results.h:58
kSDKResult_False
static const SDKResult kSDKResult_False
Operation completed successfully with false result.
Definition: sdk_results.h:28
sdk::ErrorCodes
ErrorCodes
Error codes.
Definition: sdk_results_enum.h:21
kSDKResult_BufferTooSmall
static const SDKResult kSDKResult_BufferTooSmall
Buffer too small.
Definition: sdk_results.h:118