IDataset Class Reference

Provides access to members that supply dataset information. More...

#include <gdb_dataset.h>

Inheritance diagram for IDataset:

Public Member Functions
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 dataset information.

Member Function Documentation

GetWorkspace()

virtual GDBResult SDK_CALLTYPE GetWorkspace ( IWorkspace **  workspace ) const throw ( )

pure virtual

Returns the containing workspace for this dataset.

Parameters

[out]

workspace

Address of a variable that receives the pointer to the IWorkspace interface associated with a workspace containing this dataset.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetDatasetProperty()

virtual GDBResult SDK_CALLTYPE GetDatasetProperty ( SDKUInt32  id, SDKAny &  value  ) const throw ( )

pure virtual

Returns a value of the specified property of a dataset.

Parameters

[in]	id	The identifier of the property.
[out]	value	Address of a variable that receives the value of the property.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetBounds()

virtual GDBResult SDK_CALLTYPE GetBounds ( geometry::IEnvelope **  envelope ) const throw ( )

pure virtual

Returns boundaries of a dataset.

Parameters

[out]

envelope

Pointer to a variable that receives the boundaries of a dataset.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetCoverage()

virtual GDBResult SDK_CALLTYPE GetCoverage ( geometry::IGeometry **  coverage ) const throw ( )

pure virtual

Returns the coverage of a dataset.

Parameters

[out]

coverage

Address of a variable that receives the pointer to the IGeometry interface associated with a geometry object which contains the dataset coverage.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetDataStream()

virtual GDBResult SDK_CALLTYPE GetDataStream ( gdb::IGDBStream **  stream ) const throw ( )

pure virtual

Returns the stream associated with the dataset raw data.

Parameters

[out]

stream

Address of a variable that receives the pointer to the IGDBStream interface associated with the dataset raw data.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetData()

virtual GDBResult SDK_CALLTYPE GetData ( SDKUInt8 **  data, SDKUInt64 *  length  ) const throw ( )

pure virtual

Returns the pointer to the dataset raw data.

Parameters

[out]	data	Address of a variable that receives the pointer to the dataset raw data.
[out]	length	Address of a variable that receives the length of the dataset raw data.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotExist

GetDatasetObject()

virtual GDBResult SDK_CALLTYPE GetDatasetObject ( ObjectID  id, IQueryParameters *  param, IObject **  object  ) throw ( )

pure virtual

Returns a dataset object specified by the object identifier.

Parameters

[in]	id	An object identifier.
[in]	param	Pointer the query parameters (see GetObjectParameter).
[out]	Address	of a variable that receives the pointer to the IObject interface associated with the dataset object.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

kSDKResult_InvalidArgument

kSDKResult_NotFound

---

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

• gdb_dataset.h