IManualUpdates Class Reference

Provides methods for manual updating of datasets. With this interface you can add a new object to a specified dataset, modify and delete existing objects, clear all manual updates applied to the a dataset. More...

#include <manual_updates_interface.h>

Inheritance diagram for IManualUpdates:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	EditFeature (const SDK_GDB_NAMESPACE::IFeatureSP &feature, SDK_GDB_NAMESPACE::IFeatureEditSP &feature_editor)=0 throw ()
	Edits an existing feature. More...
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 throw ()
	Edits an existing feature or creates a new one. More...
virtual SDKResult SDK_CALLTYPE	DeleteFeature (const SDK_GDB_NAMESPACE::IFeatureSP &feature, const SDK_GDB_NAMESPACE::IQueryParametersSP &parameters)=0 throw ()
	Deletes a feature from a specified data set. More...
virtual SDKResult SDK_CALLTYPE	DeleteUpdates (const SDK_GDB_NAMESPACE::IFeatureSP &feature)=0 throw ()
	Destroys all records relating to the specified feature. More...
virtual SDKResult SDK_CALLTYPE	ClearUpdates (const SDK_GDB_NAMESPACE::IWorkspaceSP &workspace, const SDK_GDB_NAMESPACE::IQueryParametersSP &parameters)=0 throw ()
	Destroys specified update records in a specified dataset. More...
virtual SDKResult SDK_CALLTYPE	SetDatasetProperty (const SDK_GDB_NAMESPACE::IFeatureDatasetSP &dataset, SDKUInt32 id, const SDKAny &value)=0 throw ()
	Sets a dataset property. More...
virtual SDKResult SDK_CALLTYPE	GetDatasetProperty (const SDK_GDB_NAMESPACE::IFeatureDatasetSP &dataset, SDKUInt32 id, SDKAny &value)=0 throw ()
	Gets a dataset property. More...
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 throw ()
	Gets a dataset editor. 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 methods for manual updating of datasets. With this interface you can add a new object to a specified dataset, modify and delete existing objects, clear all manual updates applied to the a dataset.

Member Function Documentation

EditFeature()

virtual SDKResult SDK_CALLTYPE EditFeature ( const SDK_GDB_NAMESPACE::IFeatureSP &  feature, SDK_GDB_NAMESPACE::IFeatureEditSP &  feature_editor  ) throw ( )

pure virtual

Edits an existing feature.

Parameters

[in]	feature	Parent feature interface.
[out]	feature_editor	Feature editor interface.

Returns

kSDKResult_Succeeded

kSDKResult_InvalidArgument

kSDKResult_NotImplemented

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  ) throw ( )

pure virtual

Edits an existing feature or creates a new one.

Parameters

[in]	dataset	Pointer to the parent dataset interface if the update is applied to a specific dataset (otherwise 0).
[in]	type	Type of the object's geometry.
[in]	coord_dim	Coordinates dimension of the object.
[out]	feature_editor	Feature editor interface.

Returns

kSDKResult_Succeeded

kSDKResult_InvalidArgument

kSDKResult_NotImplemented

DeleteFeature()

virtual SDKResult SDK_CALLTYPE DeleteFeature ( const SDK_GDB_NAMESPACE::IFeatureSP &  feature, const SDK_GDB_NAMESPACE::IQueryParametersSP &  parameters  ) throw ( )

pure virtual

Deletes a feature from a specified data set.

Parameters

[in]

feature

Parent feature interface.

Returns

kSDKResult_Succeeded if ok

kSDKResult_NotExist if the specified feature does not exist

kSDKResult_NotImplemented

DeleteUpdates()

virtual SDKResult SDK_CALLTYPE DeleteUpdates ( const SDK_GDB_NAMESPACE::IFeatureSP &  feature ) throw ( )

pure virtual

Destroys all records relating to the specified feature.

Parameters

[in]

feature

Parent feature interface.

Returns

kSDKResult_Succeeded if ok

kSDKResult_NotImplemented

ClearUpdates()

virtual SDKResult SDK_CALLTYPE ClearUpdates ( const SDK_GDB_NAMESPACE::IWorkspaceSP &  workspace, const SDK_GDB_NAMESPACE::IQueryParametersSP &  parameters  ) throw ( )

pure virtual

Destroys specified update records in a specified dataset.

Parameters

[in]	workspace	Workspace associated with the specified database.
[in]	parameters	Parameters for clearing of update records.

Returns

kSDKResult_Succeeded

kSDKResult_InvalidArgument

kSDKResult_NotImplemented

SetDatasetProperty()

virtual SDKResult SDK_CALLTYPE SetDatasetProperty ( const SDK_GDB_NAMESPACE::IFeatureDatasetSP &  dataset, SDKUInt32  id, const SDKAny &  value  ) throw ( )

pure virtual

Sets a dataset property.

Parameters

[in]	dataset	Pointer to the dataset interface
[in]	id	Property identifier.
[in]	value	Property value.

Returns

kSDKResult_Succeeded if ok

kSDKResult_NotImplemented

GetDatasetProperty()

virtual SDKResult SDK_CALLTYPE GetDatasetProperty ( const SDK_GDB_NAMESPACE::IFeatureDatasetSP &  dataset, SDKUInt32  id, SDKAny &  value  ) throw ( )

pure virtual

Gets a dataset property.

Parameters

[in]	dataset	Pointer to the dataset interface
[in]	id	Property identifier.
[in]	value	Property value.

Returns

kSDKResult_Succeeded if ok

kSDKResult_NotImplemented

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  ) throw ( )

pure virtual

Gets a dataset editor.

Parameters

[in]	dataset	Optional. Reference to the dataset.
[in]	master_dataset	Optional. Reference to the master dataset.
[in]	dataset_pathname	Dataset pathname.
[out]	dataset_editor	Address of variable that receives the dataset editor.

Returns

kSDKResult_Succeeded if ok

kSDKResult_NotImplemented

---

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

• manual_updates_interface.h