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

Provides access to members that supply feature dataset information. A FeatureDataset is a dataset that contains features that share the same spatial reference as the Feature Dataset. More...

#include <gdb_dataset.h>

Inheritance diagram for IFeatureDataset:
IDataset ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE GetFeatures (geometry::IGeometry *geometry_filter, IQueryParameters *parameters, IFeatureFilter *back_call_feature_filter, IEnumFeature **features)=0 throw ()
 Returns an enumeration of the features which contain in this dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetFeature (ObjectID id, IFeature **feature)=0 throw ()
 Returns the feature specified by the object identifier. More...
 
virtual GDBResult SDK_CALLTYPE GetGeometries (geometry::IGeometry *geometry_filter, IQueryParameters *parameters, IEnumGDBGeometry **geometries)=0 throw ()
 Returns an enumeration of the geometry objects which contain in this dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetFeaturesByFOID (const SDKAny &foid, IEnumFeature **features)=0 throw ()
 Returns an enumeration of the features specified by FOID. More...
 
virtual GDBResult SDK_CALLTYPE GetFeatureByRCID (RCID rcid, IFeature **feature) noexcept=0
 Returns a feature specified by RCID. More...
 
- Public Member Functions inherited from IDataset
virtual GDBResult SDK_CALLTYPE GetDatasetID (DatasetID &dsid) const =0 throw ()
 Returns the identifier of a dataset.
 
virtual GDBResult SDK_CALLTYPE GetDatasetName (SDKString &name) const =0 throw ()
 Returns the dataset name.
 
virtual GDBResult SDK_CALLTYPE GetDatasetType (DatasetType &dsty) const =0 throw ()
 Returns the type a dataset.
 
virtual GDBResult SDK_CALLTYPE GetDatasetPRSP (PRSP &prsp) const =0 throw ()
 Returns the product specification identifier of a dataset.
 
virtual GDBResult SDK_CALLTYPE GetWorkspace (IWorkspace **workspace) const =0 throw ()
 Returns the containing workspace for this dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetDatasetProperty (SDKUInt32 id, SDKAny &value) const =0 throw ()
 Returns a value of the specified property of a dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetBounds (geometry::IEnvelope **envelope) const =0 throw ()
 Returns boundaries of a dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetCoverage (geometry::IGeometry **coverage) const =0 throw ()
 Returns the coverage of a dataset. More...
 
virtual GDBResult SDK_CALLTYPE GetDataStream (gdb::IGDBStream **stream) const =0 throw ()
 Returns the stream associated with the dataset raw data. More...
 
virtual GDBResult SDK_CALLTYPE GetData (SDKUInt8 **data, SDKUInt64 *length) const =0 throw ()
 Returns the pointer to the dataset raw data. More...
 
virtual GDBResult SDK_CALLTYPE GetDatasetObject (ObjectID id, IQueryParameters *param, IObject **object)=0 throw ()
 Returns a dataset object specified by the object identifier. 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 supply feature dataset information. A FeatureDataset is a dataset that contains features that share the same spatial reference as the Feature Dataset.

Member Function Documentation

◆ GetFeatures()

virtual GDBResult SDK_CALLTYPE GetFeatures ( geometry::IGeometry *  geometry_filter,
IQueryParameters *  parameters,
IFeatureFilter *  back_call_feature_filter,
IEnumFeature **  features 
)
throw (
)
pure virtual

Returns an enumeration of the features which contain in this dataset.

Parameters
[in]geometry_filterPointer to the IGeometry interface associated with the geometry object.
[in]parametersSet of parameters that specify request for the feature iteration IQueryParameters
[in]back_call_feature_filterPointer to the IFeatureFilter interface associated with the filter of the features. Called for every feature in iteration.
[out]featuresAddress of a variable that receives the pointer to the IEnumFeature interface associated with the feature enumeration object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotFound

◆ GetFeature()

virtual GDBResult SDK_CALLTYPE GetFeature ( ObjectID  id,
IFeature **  feature 
)
throw (
)
pure virtual

Returns the feature specified by the object identifier.

Parameters
[in]idThe object identifier.
[out]featureAddress of a variable that receives the pointer to the IFeature interface associated with the feature.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotFound

◆ GetGeometries()

virtual GDBResult SDK_CALLTYPE GetGeometries ( geometry::IGeometry *  geometry_filter,
IQueryParameters *  parameters,
IEnumGDBGeometry **  geometries 
)
throw (
)
pure virtual

Returns an enumeration of the geometry objects which contain in this dataset.

Parameters
[in]geometry_filterPointer to the IGeometry interface associated with the geometry object.
[in]parametersPointer to the IQueryParameters interface associated with object parameters.
[out]geometriesAddress of a variable that receives the pointer to the IEnumGDBGeometry interface associated with the geometry enumeration object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotFound

◆ GetFeaturesByFOID()

virtual GDBResult SDK_CALLTYPE GetFeaturesByFOID ( const SDKAny &  foid,
IEnumFeature **  features 
)
throw (
)
pure virtual

Returns an enumeration of the features specified by FOID.

Parameters
[in]foidFeature object identifier.
[out]featuresAddress of a variable that receives the pointer to the IEnumFeature interface associated with the feature enumeration object.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotFound

◆ GetFeatureByRCID()

virtual GDBResult SDK_CALLTYPE GetFeatureByRCID ( RCID  rcid,
IFeature **  feature 
)
pure virtualnoexcept

Returns a feature specified by RCID.

Parameters
[in]rcidFeature record id
[out]featureAddress of a variable that receives the pointer to the IFeature interface associated with the feature.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument
kSDKResult_NotFound

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