NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
resource_interface.h
Go to the documentation of this file.
1 #ifndef SDK_BASE_LIBRARY_RESOURCE_INTERFACE_H_
11 #define SDK_BASE_LIBRARY_RESOURCE_INTERFACE_H_
12 
13 #include <base/inc/platform.h>
14 #include <base/inc/base_types.h>
15 #include <base/inc/sdk_results.h>
17 #include <base/inc/interfaces/resource/xml_interface.h>
21 
25 static const wchar_t* kSDKResourceClass_Unknown = L"";
26 static const wchar_t* kSDKResourceClass_FileSystem = L"file-system";
27 static const wchar_t* kSDKResourceClass_FileSystem_Temporary = L"file-system-temporary";
28 static const wchar_t* kSDKResourceClass_MemoryBuffer = L"memory-buffer";
29 static const wchar_t* kSDKResourceClass_MemoryBuffer_Temporary = L"memory-buffer-temporary";
30 static const wchar_t* kSDKResourceClass_RemoteFileSystem = L"remote-file-system";
31 
36 static const wchar_t* kSDKResourceType_Unknown = L"";
37 static const wchar_t* kSDKResourceType_Entity = L"entity";
38 static const wchar_t* kSDKResourceType_Storage = L"storage";
39 
43 static const wchar_t* kResourceProperty_LastWriteTime = L"last write time";
44 
48 {
54 };
55 
59 {
63 };
64 
65 typedef SDKUInt32 ResourceClass;
66 typedef SDKUInt32 ResourceClassType;
67 
71 {
74 };
75 
78 
80 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
81 SDKGetResource(const SDKString& resource_class, const SDKString& resource_type,
82  const SDKString& name, sdk::base::IMemoryAllocator* allocator,
83  sdk::ISDKParameters* parameters, sdk::base::ISDKResource** resource);
84 
86 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
87 SDKGetResourceManager(const SDKString& resource_class,
89 
91 SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE
93  SDKResourceReaderType reader_type, sdk::ISDKComponent** reader);
94 
96 
97 #endif // SDK_BASE_LIBRARY_RESOURCE_INTERFACE_H_
sdk::base::ISDKResource
Provides access to members that return information about and manage the resource object.
Definition: generic_resource_interface.h:53
kResourceType_Unknown
@ kResourceType_Unknown
Unknown resource type.
Definition: resource_interface.h:60
kSDKResourceClass_MemoryBuffer_Temporary
static const wchar_t * kSDKResourceClass_MemoryBuffer_Temporary
Temporary memory buffer class.
Definition: resource_interface.h:29
kResourceClass_MemoryBuffer_Temporary
@ kResourceClass_MemoryBuffer_Temporary
Temporary memory buffer resource class.
Definition: resource_interface.h:53
SDKCreateResourceReader
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKCreateResourceReader(sdk::base::ISDKStream *input_stream, SDKResourceReaderType reader_type, sdk::ISDKComponent **reader)
Creates resource readers.
SDKResourceReaderType_XML
@ SDKResourceReaderType_XML
ISDKXMLNode.
Definition: resource_interface.h:73
sdk_results.h
A list of SDK error/return results.
kSDKResourceClass_Unknown
static const wchar_t * kSDKResourceClass_Unknown
Resource classes.
Definition: resource_interface.h:25
sdk::base::ISDKResourceManager
Provides access to members that manage the resource object.
Definition: generic_resource_interface.h:154
base_types.h
SDK base types.
SDKGetResource
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKGetResource(const SDKString &resource_class, const SDKString &resource_type, const SDKString &name, sdk::base::IMemoryAllocator *allocator, sdk::ISDKParameters *parameters, sdk::base::ISDKResource **resource)
Searches for specified resource and returns reference to it.
kResourceType_Storage
@ kResourceType_Storage
Storage resource type, e.g. folder.
Definition: resource_interface.h:62
generic_resource_interface.h
Generic data resource interfaces.
sdk::base::ISDKStream
Generic data stream interface.
Definition: stream_interface.h:32
kResourceType_Entity
@ kResourceType_Entity
Entity resource type, e.g. file.
Definition: resource_interface.h:61
SDKResourceClassType
SDKResourceClassType
Resource class type enum.
Definition: resource_interface.h:58
kResourceClass_FileSystem_Temporary
@ kResourceClass_FileSystem_Temporary
Temporary file resource class.
Definition: resource_interface.h:51
parameters_interface.h
Provides access to members for managing a parameter set.
sdk::ISDKParameters
Provides access to members that manage parameters of an object.
Definition: parameters_interface.h:33
kSDKResourceClass_FileSystem
static const wchar_t * kSDKResourceClass_FileSystem
File system class.
Definition: resource_interface.h:26
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
stream_interface.h
Generic data stream interface.
sdk::base::IMemoryAllocator
Memory allocator interface.
Definition: allocator_interface.h:26
kSDKResourceClass_RemoteFileSystem
static const wchar_t * kSDKResourceClass_RemoteFileSystem
Remote file system class.
Definition: resource_interface.h:30
kSDKResourceType_Unknown
static const wchar_t * kSDKResourceType_Unknown
Resource types.
Definition: resource_interface.h:36
allocator_interface.h
Memory allocator interface.
platform.h
Describes the platform constants.
kSDKResourceType_Storage
static const wchar_t * kSDKResourceType_Storage
Storage resource type, e.g. folder.
Definition: resource_interface.h:38
kResourceClass_FileSystem
@ kResourceClass_FileSystem
File resource class.
Definition: resource_interface.h:50
kResourceClass_Unknown
@ kResourceClass_Unknown
Unknown resource class.
Definition: resource_interface.h:49
kResourceProperty_LastWriteTime
static const wchar_t * kResourceProperty_LastWriteTime
Resource properties.
Definition: resource_interface.h:43
kSDKResourceClass_FileSystem_Temporary
static const wchar_t * kSDKResourceClass_FileSystem_Temporary
Temporary file class.
Definition: resource_interface.h:27
SDKResourceReaderType
SDKResourceReaderType
Data reader types.
Definition: resource_interface.h:70
kResourceClass_MemoryBuffer
@ kResourceClass_MemoryBuffer
Memory buffer resource class.
Definition: resource_interface.h:52
SDKGetResourceManager
SDK_EXTERN_C SDK_BASE_LIBRARY_EXPORT_API SDKResult SDK_APICALLTYPE SDKGetResourceManager(const SDKString &resource_class, sdk::base::ISDKResourceManager **manager)
Creates resource manager which is needed for resource manipulation.
SDKResourceClass
SDKResourceClass
Resource class enum.
Definition: resource_interface.h:47
kSDKResourceClass_MemoryBuffer
static const wchar_t * kSDKResourceClass_MemoryBuffer
Memory buffer class.
Definition: resource_interface.h:28
SDKResourceReaderType_SequentialXML
@ SDKResourceReaderType_SequentialXML
ISDKXMLSequentialReader.
Definition: resource_interface.h:72
kSDKResourceType_Entity
static const wchar_t * kSDKResourceType_Entity
Entity resource type, e.g. file.
Definition: resource_interface.h:37