resource_interface.h File Reference

Main access function to resources. More...

#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_results.h>
#include <base/inc/interfaces/resource/generic_resource_interface.h>
#include <base/inc/interfaces/resource/xml_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <base/inc/interfaces/memory/allocator_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>

Go to the source code of this file.

Enumerations
enum	SDKResourceClass {   kResourceClass_Unknown = 0, kResourceClass_FileSystem, kResourceClass_FileSystem_Temporary, kResourceClass_MemoryBuffer,   kResourceClass_MemoryBuffer_Temporary }
	Resource class enum. More...
enum	SDKResourceClassType { kResourceType_Unknown = 0, kResourceType_Entity, kResourceType_Storage }
	Resource class type enum. More...
enum	SDKResourceReaderType { SDKResourceReaderType_SequentialXML, SDKResourceReaderType_XML }
	Data reader types. More...

Functions
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.
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.
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.

Variables
static const wchar_t *	kResourceProperty_LastWriteTime = L"last write time"
	Resource properties.
static const wchar_t *	kSDKResourceClass_Unknown = L""
	Resource classes. More...
static const wchar_t *	kSDKResourceClass_FileSystem = L"file-system"
	File system class.
static const wchar_t *	kSDKResourceClass_FileSystem_Temporary = L"file-system-temporary"
	Temporary file class.
static const wchar_t *	kSDKResourceClass_MemoryBuffer = L"memory-buffer"
	Memory buffer class.
static const wchar_t *	kSDKResourceClass_MemoryBuffer_Temporary = L"memory-buffer-temporary"
	Temporary memory buffer class.
static const wchar_t *	kSDKResourceClass_RemoteFileSystem = L"remote-file-system"
	Remote file system class.
static const wchar_t *	kSDKResourceType_Unknown = L""
	Resource types. More...
static const wchar_t *	kSDKResourceType_Entity = L"entity"
	Entity resource type, e.g. file.
static const wchar_t *	kSDKResourceType_Storage = L"storage"
	Storage resource type, e.g. folder.

Detailed Description

Main access function to resources.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author

The NAVTOR SDK authors

Date

08/2011

Maintenance:

The NAVTOR SDK authors

Enumeration Type Documentation

SDKResourceClass

enum SDKResourceClass

Resource class enum.

Enumerator
kResourceClass_Unknown	Unknown resource class.
kResourceClass_FileSystem	File resource class.
kResourceClass_FileSystem_Temporary	Temporary file resource class.
kResourceClass_MemoryBuffer	Memory buffer resource class.
kResourceClass_MemoryBuffer_Temporary	Temporary memory buffer resource class.

SDKResourceClassType

enum SDKResourceClassType

Resource class type enum.

Enumerator
kResourceType_Unknown	Unknown resource type.
kResourceType_Entity	Entity resource type, e.g. file.
kResourceType_Storage	Storage resource type, e.g. folder.

SDKResourceReaderType

enum SDKResourceReaderType

Data reader types.

Enumerator
SDKResourceReaderType_SequentialXML	ISDKXMLSequentialReader.
SDKResourceReaderType_XML	ISDKXMLNode.

Variable Documentation

kSDKResourceClass_Unknown

const wchar_t* kSDKResourceClass_Unknown = L""

static

Resource classes.

Unknown class.

kSDKResourceType_Unknown

const wchar_t* kSDKResourceType_Unknown = L""

static

Resource types.

Unknown resource type.