NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
IRootCatalogFactory Class Referenceabstract
Data Layer » Workspace » Catalogs » Root Catalog

Provides access to members that create and open the root catalog. More...

#include <gdb_catalog.h>

Inheritance diagram for IRootCatalogFactory:
ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE Open (const SDKString &file_name, IRootCatalog **catalog)=0 throw ()
 Opens the data-source catalog specified by the given file name. More...
 
virtual GDBResult SDK_CALLTYPE Create (IRootCatalog **catalog)=0 throw ()
 Creates an empty root catalog. More...
 
virtual GDBResult SDK_CALLTYPE OpenFromResourceStorage (sdk::base::ISDKResourceStorage *resource_storage, IRootCatalog **catalog) noexcept=0
 Opens the data-source catalog specified by ISDKResourceStorage. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Provides access to members that create and open the root catalog.

Member Function Documentation

◆ Open()

virtual GDBResult SDK_CALLTYPE Open ( const SDKString &  file_name,
IRootCatalog **  catalog 
)
throw (
)
pure virtual

Opens the data-source catalog specified by the given file name.

Parameters
file_name[in] Pointer to the filename.
catalog[out] Address of a variable that receives a pointer the ICatalog interface associated with the opened geodatabase catalog.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound
kSDKResult_BadFormat

◆ Create()

virtual GDBResult SDK_CALLTYPE Create ( IRootCatalog **  catalog)
throw (
)
pure virtual

Creates an empty root catalog.

Parameters
catalog[out] Address of a variable that receives a pointer the IRootCatalog interface associated with the opened geodatabase catalog.
Returns
Ok
kSDKResult_Succeeded

◆ OpenFromResourceStorage()

virtual GDBResult SDK_CALLTYPE OpenFromResourceStorage ( sdk::base::ISDKResourceStorage *  resource_storage,
IRootCatalog **  catalog 
)
pure virtualnoexcept

Opens the data-source catalog specified by ISDKResourceStorage.

Parameters
resource[in] Pointer to ISDKResource.
catalog[out] Address of a variable that receives a pointer the ICatalog interface associated with the opened geodatabase catalog.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound
kSDKResult_BadFormat
The documentation for this class was generated from the following file: