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

Provides editing of a dataset. More...

#include <gdb_dataset_edit.h>

Inheritance diagram for IDatasetEdit:
IFeatureDatasetEdit

Public Member Functions

virtual GDBResult SDK_CALLTYPE SetDatasetProperty (SDKUInt32 id, const SDKAny &value) noexcept=0
 Sets a value of a specified property of the dataset. More...
 
virtual GDBResult SDK_CALLTYPE SetBounds (geometry::IEnvelope *envelope) noexcept=0
 Sets the envelope of the dataset. More...
 
virtual GDBResult SDK_CALLTYPE SetCoverage (geometry::IGeometry *coverage) noexcept=0
 Sets the coverage of the dataset. More...
 
virtual GDBResult SDK_CALLTYPE SetDataStream (const gdb::IGDBStream *stream) noexcept=0
 Reads the dataset from raw data. More...
 
virtual GDBResult SDK_CALLTYPE CreateObject (ObjectType type, ClassCode code, ObjectID &oid, IObjectEdit **object) noexcept=0
 Creates a new object. More...
 
virtual GDBResult SDK_CALLTYPE DeleteObject (ObjectID oid) noexcept=0
 Deletes a specified object from the dataset. More...
 
virtual GDBResult SDK_CALLTYPE AddRelationship (ObjectID owner, ObjectID member, RelationshipClass relationship_class, RelationshipRole role, ObjectID &rel_id) noexcept=0
 Adds a relationship between two existing objects in the dataset. More...
 
virtual GDBResult SDK_CALLTYPE ModifyObjects (const SDKArray &object_rcids, SDKUInt32 operation, const IEnumSDKParameterSP &attributes) noexcept=0
 This method is intended for a group operations. Modify attributes or flags for set of objects. NB! Applicable only for user objects datasets. More...
 

Detailed Description

Provides editing of a dataset.

Member Function Documentation

◆ SetDatasetProperty()

virtual GDBResult SDK_CALLTYPE SetDatasetProperty ( SDKUInt32  id,
const SDKAny &  value 
)
pure virtualnoexcept

Sets a value of a specified property of the dataset.

Parameters
[in]idThe identifier of the property.
[in]valueValue (Any type) of the attribute.
Returns
kSDKResult_Succeeded
kSDKResult_NotExist if the property with the specified ID does not exist
kSDKResult_InvalidArgument
kSDKResult_NotImplemented

◆ SetBounds()

virtual GDBResult SDK_CALLTYPE SetBounds ( geometry::IEnvelope *  envelope)
pure virtualnoexcept

Sets the envelope of the dataset.

Parameters
[in]envelopePointer to the IEnvelope interface associated with the envelope object containing the dataset envelope.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotExist

◆ SetCoverage()

virtual GDBResult SDK_CALLTYPE SetCoverage ( geometry::IGeometry *  coverage)
pure virtualnoexcept

Sets the coverage of the dataset.

Parameters
[in]coveragePointer to the IGeometry interface associated with the geometry object containing the dataset coverage.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotExist

◆ SetDataStream()

virtual GDBResult SDK_CALLTYPE SetDataStream ( const gdb::IGDBStream *  stream)
pure virtualnoexcept

Reads the dataset from raw data.

Parameters
[in]streamPointer to the IStream interface associated with the dataset raw data.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument

◆ CreateObject()

virtual GDBResult SDK_CALLTYPE CreateObject ( ObjectType  type,
ClassCode  code,
ObjectID &  oid,
IObjectEdit **  object 
)
pure virtualnoexcept

Creates a new object.

Parameters
[in]typeObject's type.
[in]codeObject's class code.
[out]objectAddress of a variable that receives the pointer to the IObject interface associated with the created object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument

◆ DeleteObject()

virtual GDBResult SDK_CALLTYPE DeleteObject ( ObjectID  oid)
pure virtualnoexcept

Deletes a specified object from the dataset.

Parameters
[in]oidInternal identifier of the object.
Returns
kSDKResult_Succeeded
SDKResult_NotExist if there is no object with the specified ID.
kSDKResult_NotImplemented

◆ AddRelationship()

virtual GDBResult SDK_CALLTYPE AddRelationship ( ObjectID  owner,
ObjectID  member,
RelationshipClass  relationship_class,
RelationshipRole  role,
ObjectID &  rel_id 
)
pure virtualnoexcept

Adds a relationship between two existing objects in the dataset.

Parameters
[in]ownerID of the object-owner of the relation.
[in]memberID of the object-member of the relation.
[in]relationship_classRelation class code.
[in]RelationshipRoleRole of the member in this relation.
[out]rel_idID of the relationship type object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument

◆ ModifyObjects()

virtual GDBResult SDK_CALLTYPE ModifyObjects ( const SDKArray &  object_rcids,
SDKUInt32  operation,
const IEnumSDKParameterSP &  attributes 
)
pure virtualnoexcept

This method is intended for a group operations. Modify attributes or flags for set of objects. NB! Applicable only for user objects datasets.

Parameters
[in]object_rcidsSet of RCIDs of objects.
[in]operationOperation, check enum ModifyObjectOp.
[in]relationship_classRelation class code.
[in]RelationshipRoleRole of the member in this relation.
[out]rel_idID of the relationship type object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument

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