NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
configuration_interface.h
Go to the documentation of this file.
1 #ifndef SDK_BASE_LIBRARY_CONFIGURATION_INTERFACE_H_
11 #define SDK_BASE_LIBRARY_CONFIGURATION_INTERFACE_H_
12 
13 #include <base/inc/platform.h>
14 #include <base/inc/base_types.h>
15 #include <base/inc/sdk_results.h>
16 #include <base/inc/interfaces/configuration/generic_configuration_interface.h>
17 
20 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
21 SDKSetDefaultConfigPath(const SDKString* path);
22 
26 static const char* kConfigName_Logging = "logging";
28 static const char* kConfig_Logging_On = "on";
30 static const char* kConfig_Logging_Level = "level";
32 static const char* kConfig_Logging_Root = "root";
34 static const char* kConfig_Logging_MaxSize = "max-size";
36 static const char* kConfig_Logging_RootPath = "root_path";
38 static const char* kConfig_Logging_BufLevel = "buf-level";
40 static const char* kConfig_Logging_BufTimeout = "buf-timeout";
42 static const char* kConfig_Logging_DebugInfoOn = "debug-info-on";
44 
47 enum SDKConfigurationFlags
48 {
49  SDKConfigurationFlag_Default = 0x0000,
50  SDKConfigurationFlag_ReadOnly = 0x0001,
51  SDKConfigurationFlag_Sequential = 0x0002,
52  SDKConfigurationFlag_CreateConfigInMemory = 0x1000,
53  SDKConfigurationFlag_CreateDebugConfig = SDKConfigurationFlag_CreateConfigInMemory,
54 };
55 
58 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
59 SDKGetConfig(const SDKString* file_path, const SDKString* config_path,
60  SDKUInt64 flags, sdk::base::ISDKConfiguration** config);
61 
64 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
65 SDKReadConfigExtension(const SDKString& configuration_content);
66 
67 #endif // SDK_BASE_LIBRARY_CONFIGURATION_INTERFACE_H_
sdk_results.h
A list of SDK error/return results.
base_types.h
SDK base types.
SDKGetConfig
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKGetConfig(const SDKString *file_path, const SDKString *config_path, SDKUInt64 flags, sdk::base::ISDKConfiguration **config)
Retrieves reference to configuration component.
SDKConfigurationFlag_CreateConfigInMemory
@ SDKConfigurationFlag_CreateConfigInMemory
creates empty configuration in memory
Definition: configuration_interface.h:52
SDKConfigurationFlag_ReadOnly
@ SDKConfigurationFlag_ReadOnly
creates read only version otherwise read/write one
Definition: configuration_interface.h:50
kConfig_Logging_BufTimeout
static const char * kConfig_Logging_BufTimeout
Logging buffering timeout (in seconds)
Definition: configuration_interface.h:40
SDKConfigurationFlag_Default
@ SDKConfigurationFlag_Default
no flags set
Definition: configuration_interface.h:49
sdk::base::ISDKConfiguration
Provides access to members that return information and manage the configuration.
Definition: generic_configuration_interface.h:34
kConfigName_Logging
static const char * kConfigName_Logging
Logging section.
Definition: configuration_interface.h:26
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
kConfig_Logging_On
static const char * kConfig_Logging_On
Logging on/off.
Definition: configuration_interface.h:28
SDKSetDefaultConfigPath
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKSetDefaultConfigPath(const SDKString *path)
Sets default path for configuration.
kConfig_Logging_Root
static const char * kConfig_Logging_Root
Logging root path.
Definition: configuration_interface.h:32
platform.h
Describes the platform constants.
SDKConfigurationFlag_Sequential
@ SDKConfigurationFlag_Sequential
creates sequentially read version otherwise the whole config is loaded into memory
Definition: configuration_interface.h:51
SDKReadConfigExtension
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKReadConfigExtension(const SDKString &configuration_content)
Reads configuration extension from the specified content.
kConfig_Logging_DebugInfoOn
static const char * kConfig_Logging_DebugInfoOn
Turn on memory consumption logging.
Definition: configuration_interface.h:42
kConfig_Logging_Level
static const char * kConfig_Logging_Level
Logging level.
Definition: configuration_interface.h:30
SDKConfigurationFlags
SDKConfigurationFlags
Flags which controls configuration implementation.
Definition: configuration_interface.h:47
kConfig_Logging_RootPath
static const char * kConfig_Logging_RootPath
Logging root path.
Definition: configuration_interface.h:36
kConfig_Logging_MaxSize
static const char * kConfig_Logging_MaxSize
Log file max size.
Definition: configuration_interface.h:34
kConfig_Logging_BufLevel
static const char * kConfig_Logging_BufLevel
Logging buffered level (all logs with level <= buf-level are buffered)
Definition: configuration_interface.h:38