NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
component_interface.h
Go to the documentation of this file.
1 #ifndef SDK_BASE_LIBRARY_COMPONENT_INTERFACE_H_
11 #define SDK_BASE_LIBRARY_COMPONENT_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/sdk_component_interface.h>
17 
18 static const char* kDefCreateFactoryFunctionName = "CreateFactory";
19 static const char* kDefInitializationFunctionName = "InitializeLibrary";
20 static const char* kDefUninitializationFunctionName = "UninitializeLibrary";
21 static const char* kDefCanUnloadFunctionName = "CanUnloadLibrary";
22 static const char* kDefDebugCommandFunctionName = "ProcessDebugCommand";
23 
26 typedef SDKResult (SDK_APICALLTYPE *SDKCreateFactoryFunction)(
27  const sdk::ComponentId& id, sdk::ISDKClassFactory** factory);
28 
31 typedef SDKResult (SDK_APICALLTYPE *SDKInitializeLibraryFunction)();
32 
35 typedef SDKResult (SDK_APICALLTYPE *SDKUninitializeLibraryFunction)();
36 
39 typedef SDKResult (SDK_APICALLTYPE *SDKCanUnloadLibraryFunction)();
40 
43 typedef SDKResult (SDK_APICALLTYPE *SDKProcessDebugCommandFunction)(
44  SDKUInt32 command, SDKAny* param);
45 #endif // SDK_BASE_LIBRARY_COMPONENT_INTERFACE_H_
SDKInitializeLibraryFunction
SDKResult(SDK_APICALLTYPE * SDKInitializeLibraryFunction)()
Initializes the whole library.
Definition: component_interface.h:31
sdk_results.h
A list of SDK error/return results.
base_types.h
SDK base types.
SDKCanUnloadLibraryFunction
SDKResult(SDK_APICALLTYPE * SDKCanUnloadLibraryFunction)()
Checks library if it can be unloaded.
Definition: component_interface.h:39
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
SDKUninitializeLibraryFunction
SDKResult(SDK_APICALLTYPE * SDKUninitializeLibraryFunction)()
Uninitializes the whole library (usually before unloading)
Definition: component_interface.h:35
sdk_component_interface.h
Common base SDK interfaces.
platform.h
Describes the platform constants.
SDKProcessDebugCommandFunction
SDKResult(SDK_APICALLTYPE * SDKProcessDebugCommandFunction)(SDKUInt32 command, SDKAny *param)
Debug command.
Definition: component_interface.h:43
SDKCreateFactoryFunction
SDKResult(SDK_APICALLTYPE * SDKCreateFactoryFunction)(const sdk::ComponentId &id, sdk::ISDKClassFactory **factory)
Creates class factory component of specified object id.
Definition: component_interface.h:26
ComponentId
Uuid ComponentId
Definition of component UUID.
Definition: sdk_uuid.h:42