NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IWorkspaceEdit Class Referenceabstract

Provides access to members that control workspace editing. More...

#include <gdb_workspace_edit.h>

Inherits ISDKEdit.

Public Member Functions

virtual GDBResult SDK_CALLTYPE SetCatalog (CatalogType type, ICatalog *catalog)=0 throw ()
 Sets a catalog. More...
 
virtual GDBResult SDK_CALLTYPE SetWorkspaceProperty (WorkspacePropertyId property_id, const SDKAny &value)=0 throw ()
 Sets a property of a workspace. More...
 
virtual GDBResult SDK_CALLTYPE CreateDataset (DatasetType dataset_type, const SDKString &name, PRSP prsp, DatasetID &id, IDataset **dataset)=0 throw ()
 Creates a dataset specified by a dataset type and dataset properties. More...
 
virtual GDBResult SDK_CALLTYPE DeleteDataset (DatasetID dataset_id)=0 throw ()
 Deletes a dataset from the workspace. More...
 

Detailed Description

Provides access to members that control workspace editing.

Member Function Documentation

◆ SetCatalog()

virtual GDBResult SDK_CALLTYPE SetCatalog ( CatalogType  type,
ICatalog *  catalog 
)
throw (
)
pure virtual

Sets a catalog.

Parameters
[in]root_catalogPointer to the IRootCatalog interface associated with a root catalog.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument

◆ SetWorkspaceProperty()

virtual GDBResult SDK_CALLTYPE SetWorkspaceProperty ( WorkspacePropertyId  property_id,
const SDKAny &  value 
)
throw (
)
pure virtual

Sets a property of a workspace.

Parameters
[in]property_idA property identifier.
[out]valueAddress of a variable that contains the property value.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotExist
kSDKResult_BadType

◆ CreateDataset()

virtual GDBResult SDK_CALLTYPE CreateDataset ( DatasetType  dataset_type,
const SDKString &  name,
PRSP  prsp,
DatasetID &  id,
IDataset **  dataset 
)
throw (
)
pure virtual

Creates a dataset specified by a dataset type and dataset properties.

Parameters
[in]dataset_typeA dataset type.
[in]nameA dataset name.
[in]prspA dataset PRSP.
[out]datasetAddress of a variable that receives the IDataset interface associated with the created dataset.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument
kSDKResult_NotImplemented

◆ DeleteDataset()

virtual GDBResult SDK_CALLTYPE DeleteDataset ( DatasetID  dataset_id)
throw (
)
pure virtual

Deletes a dataset from the workspace.

Parameters
[in]dataset_idIdentifier of the dataset to be deleted.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_CantPerformAction
kSDKResult_NotFound

The documentation for this class was generated from the following file: