NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
manual_updates_interface.h
Go to the documentation of this file.
1 #ifndef SDK_MU_INTERFACE_H_
10 #define SDK_MU_INTERFACE_H_
11 #pragma once
12 
13 #include <base/inc/base_types.h>
14 #include <base/inc/sdk_results.h>
15 #include <base/inc/sdk_ref_ptr.h>
23 #include <datalayer/inc/manual_updates/manual_updates_const.h>
24 
25 SDK_MU_BEGIN_NAMESPACE
26 
28 
30 typedef enum WorkspaceParameters {
31  kWorkspaceParameters_RecoverCorruptedDatabase = 0,
32 } WorkspaceParameters;
33 
36 typedef enum ClearUpdatesMode {
37  kClearUpdatesMode_NotDefined = 0,
42 
45 typedef enum ClearUpdatesParameter {
49 
52 typedef enum DeleteFeatureParameter {
55 
59 class IManualUpdates : public ISDKComponent {
60 public:
67  virtual SDKResult SDK_CALLTYPE EditFeature(
68  const SDK_GDB_NAMESPACE::IFeatureSP& feature,
69  SDK_GDB_NAMESPACE::IFeatureEditSP& feature_editor) throw() = 0;
70 
80  virtual SDKResult SDK_CALLTYPE CreateFeature(
81  const SDK_GDB_NAMESPACE::IFeatureDatasetSP& dataset,
84  SDK_GDB_NAMESPACE::IFeatureEditSP& feature_editor) throw() = 0;
85 
91  virtual SDKResult SDK_CALLTYPE DeleteFeature(
92  const SDK_GDB_NAMESPACE::IFeatureSP& feature,
93  const SDK_GDB_NAMESPACE::IQueryParametersSP& parameters) throw() = 0;
94 
99  virtual SDKResult SDK_CALLTYPE DeleteUpdates(
100  const SDK_GDB_NAMESPACE::IFeatureSP& feature) throw() = 0;
101 
109  virtual SDKResult SDK_CALLTYPE ClearUpdates(
110  const SDK_GDB_NAMESPACE::IWorkspaceSP& workspace,
111  const SDK_GDB_NAMESPACE::IQueryParametersSP& parameters) throw() = 0;
112 
119  virtual SDKResult SDK_CALLTYPE SetDatasetProperty(
120  const SDK_GDB_NAMESPACE::IFeatureDatasetSP& dataset,
121  SDKUInt32 id,
122  const SDKAny& value) throw() = 0;
123 
130  virtual SDKResult SDK_CALLTYPE GetDatasetProperty(
131  const SDK_GDB_NAMESPACE::IFeatureDatasetSP& dataset,
132  SDKUInt32 id,
133  SDKAny& value) throw() = 0;
134 
143  virtual SDKResult SDK_CALLTYPE GetDatasetEditor(
144  const SDK_GDB_NAMESPACE::IDatasetSP& dataset,
145  const SDK_GDB_NAMESPACE::IDatasetSP& master_dataset,
146  const SDKString& dataset_pathname,
147  SDK_GDB_NAMESPACE::IDatasetEditSP& dataset_editor) throw() = 0;
148 
149  SDK_IMPLEMENT_IID(IManualUpdates)
150  SDK_END_INTERFACE(IManualUpdates)
151 };
152 SDK_DECLARE_IID(IManualUpdates)
153 
154 SDK_MU_END_NAMESPACE
155 
156 #endif // SDK_MU_INTERFACE_H_
157 
gdb_feature_edit.h
Describes interfaces for editing of geo-database feature object.
gdb_dataset.h
Describes interfaces that manages a geodatabase dataset object.
IManualUpdates
Provides methods for manual updating of datasets. With this interface you can add a new object to a s...
Definition: manual_updates_interface.h:59
IManualUpdates::CreateFeature
virtual SDKResult SDK_CALLTYPE CreateFeature(const SDK_GDB_NAMESPACE::IFeatureDatasetSP &dataset, SDK_GEOMETRY_NAMESPACE::GeometryType type, SDK_GEOMETRY_NAMESPACE::PointDimension coord_dim, SDK_GDB_NAMESPACE::IFeatureEditSP &feature_editor)=0
Edits an existing feature or creates a new one.
sdk_results.h
A list of SDK error/return results.
geometry.h
Describes interfaces that manages a geometry objects.
base_types.h
SDK base types.
kClearUpdatesParameter_Mode
@ kClearUpdatesParameter_Mode
Mode of clearing (see ClearingMode enum).
Definition: manual_updates_interface.h:46
ClearUpdatesParameter
ClearUpdatesParameter
Specifies the IDs of parameters that can be passed to \ the clearing of update datasets.
Definition: manual_updates_interface.h:45
kDeleteFeatureParameter_MultiPointIndexes
@ kDeleteFeatureParameter_MultiPointIndexes
Array of indexes of points in multi-point feature that should be deleted.
Definition: manual_updates_interface.h:53
sdk_ref_ptr.h
Interfaces wrapper with reference count control.
IManualUpdates::EditFeature
virtual SDKResult SDK_CALLTYPE EditFeature(const SDK_GDB_NAMESPACE::IFeatureSP &feature, SDK_GDB_NAMESPACE::IFeatureEditSP &feature_editor)=0
Edits an existing feature.
gdb_workspace.h
Describes interfaces that manages a geodatabase workspace.
IManualUpdates::GetDatasetEditor
virtual SDKResult SDK_CALLTYPE GetDatasetEditor(const SDK_GDB_NAMESPACE::IDatasetSP &dataset, const SDK_GDB_NAMESPACE::IDatasetSP &master_dataset, const SDKString &dataset_pathname, SDK_GDB_NAMESPACE::IDatasetEditSP &dataset_editor)=0
Gets a dataset editor.
kClearUpdatesMode_Edition_LE
@ kClearUpdatesMode_Edition_LE
Updates edition is less than the corresponding dataset one.
Definition: manual_updates_interface.h:39
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
IManualUpdates::DeleteFeature
virtual SDKResult SDK_CALLTYPE DeleteFeature(const SDK_GDB_NAMESPACE::IFeatureSP &feature, const SDK_GDB_NAMESPACE::IQueryParametersSP &parameters)=0
Deletes a feature from a specified data set.
gdb_const.h
Geo database constants and structures.
IManualUpdates::SetDatasetProperty
virtual SDKResult SDK_CALLTYPE SetDatasetProperty(const SDK_GDB_NAMESPACE::IFeatureDatasetSP &dataset, SDKUInt32 id, const SDKAny &value)=0
Sets a dataset property.
ClearUpdatesMode
ClearUpdatesMode
Specifies the mode of clearing of update datasets.
Definition: manual_updates_interface.h:36
sdk_component_interface.h
Common base SDK interfaces.
IManualUpdates::ClearUpdates
virtual SDKResult SDK_CALLTYPE ClearUpdates(const SDK_GDB_NAMESPACE::IWorkspaceSP &workspace, const SDK_GDB_NAMESPACE::IQueryParametersSP &parameters)=0
Destroys specified update records in a specified dataset.
kClearUpdatesParameter_TimePeriod
@ kClearUpdatesParameter_TimePeriod
Time period for storing updates, older records will be destroyed.
Definition: manual_updates_interface.h:47
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
IManualUpdates::DeleteUpdates
virtual SDKResult SDK_CALLTYPE DeleteUpdates(const SDK_GDB_NAMESPACE::IFeatureSP &feature)=0
Destroys all records relating to the specified feature.
kClearUpdatesMode_Edition_NE
@ kClearUpdatesMode_Edition_NE
Updates edition is not equal than the corresponding dataset one.
Definition: manual_updates_interface.h:38
GeometryType
GeometryType
Available types of geometry objects.
Definition: geometry.h:73
IManualUpdates::GetDatasetProperty
virtual SDKResult SDK_CALLTYPE GetDatasetProperty(const SDK_GDB_NAMESPACE::IFeatureDatasetSP &dataset, SDKUInt32 id, SDKAny &value)=0
Gets a dataset property.
gdb_dataset_edit.h
Describes interfaces for editing of geo-database dataset object.
DeleteFeatureParameter
DeleteFeatureParameter
Specifies the IDs of parameters that can be passed to \ the deleting of feature.
Definition: manual_updates_interface.h:52
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
kClearUpdatesMode_RemoveAll
@ kClearUpdatesMode_RemoveAll
Remove all.
Definition: manual_updates_interface.h:40
PointDimension
PointDimension
The coordinates dimension.
Definition: geometry.h:216