IWorkspaceFactoryUtil Class Reference

Provides access to members that is used for getting various parameter containers. More...

#include <gdb_workspace.h>

Inheritance diagram for IWorkspaceFactoryUtil:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	OpenDataProducerCodesCatalog (const SDKString *pathname, ICatalog **catalog)=0 throw ()
	Opens the data producer codes catalog. See DataProducerCodesCatalogEntryProperty for details. More...
virtual GDBResult SDK_CALLTYPE	CreateQueryParameters (IQueryParameters **parameters) const =0 throw ()
	Creates an empty Object parameters. More...
virtual GDBResult SDK_CALLTYPE	CreateRectGeometryFilter (GeoInt sw_lat, GeoInt sw_lon, GeoInt ne_lat, GeoInt ne_lon, geometry::IGeometry **filter) const =0 throw ()
	Creates a rectangular geometry filter. More...
virtual GDBResult SDK_CALLTYPE	CreateEncryptionParameters (IEncryptionParameters **encryption_parameters) const =0 throw ()
	Create an empty encryption parameters container that should be used as a workspace configuration parameter. More...
virtual GDBResult SDK_CALLTYPE	CreateGeometry (geometry::GeometryType geometry_type, geometry::IGeometryEdit **geometry) const =0 throw ()
	Creates an empty geometry container. More...
virtual GDBResult SDK_CALLTYPE	CreateAttributeCollection (IAttributeCollectionEdit **attribute_collection) const =0 throw ()
	Creates an empty attribute collection. More...
virtual GDBResult SDK_CALLTYPE	GetGroundingCheckAlerts (const SDKAny &pathname_or_prsp, IGroundingCheckAlerts **alert_filter) const =0 throw ()
	Creates and loads grounding check alert filter. More...
virtual GDBResult SDK_CALLTYPE	GetFeatureAttributesFilter (IFeatureAttributesFilter **filter) const =0 throw ()
	Creates a feature attributes filter. 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 is used for getting various parameter containers.

Member Function Documentation

OpenDataProducerCodesCatalog()

virtual GDBResult SDK_CALLTYPE OpenDataProducerCodesCatalog ( const SDKString *  pathname, ICatalog **  catalog  ) throw ( )

pure virtual

Opens the data producer codes catalog. See DataProducerCodesCatalogEntryProperty for details.

Parameters

[in]	pathname	Can be passed, optionally. If it's NULL, the pathname is taken from the main configuration.
[out]	catalog	Address of a variable that receives the pointer to the ICatalog interface associated with the data producer codes catalog

Returns

kSDKResult_Succeeded

kSDKResult_NotFound

kSDKResult_InvalidArgument

kSDKResult_BadFormat

CreateQueryParameters()

virtual GDBResult SDK_CALLTYPE CreateQueryParameters ( IQueryParameters **  parameters ) const throw ( )

pure virtual

Creates an empty Object parameters.

Parameters

[out]

parameters

Address of a variable that receives the pointer to the IQueryParameters interface associated with an object parameters.

Returns

Ok

Err_InvalidArg

CreateRectGeometryFilter()

virtual GDBResult SDK_CALLTYPE CreateRectGeometryFilter ( GeoInt  sw_lat, GeoInt  sw_lon, GeoInt  ne_lat, GeoInt  ne_lon, geometry::IGeometry **  filter  ) const throw ( )

pure virtual

Creates a rectangular geometry filter.

Parameters

[in]	sw_lat	Latitude of the South-West corner.
[in]	sw_lon	Longitude of the South-West corner.
[in]	ne_lat	Latitude of the North-East corner.
[in]	ne_lon	Longitude of the North-East corner.
[out]	filter	Address of a variable that receives the pointer to the IGeometry interface associated with the rectangular geometry.

CreateEncryptionParameters()

virtual GDBResult SDK_CALLTYPE CreateEncryptionParameters ( IEncryptionParameters **  encryption_parameters ) const throw ( )

pure virtual

Create an empty encryption parameters container that should be used as a workspace configuration parameter.

Parameters

[out]

encryption_parameters

Address of a variable that receives the IEncryptionParameters interface associated with the encryption parameters container.

Returns

kSDKResult_Succeeded

kSDKResult_InternalError

CreateGeometry()

virtual GDBResult SDK_CALLTYPE CreateGeometry ( geometry::GeometryType  geometry_type, geometry::IGeometryEdit **  geometry  ) const throw ( )

pure virtual

Creates an empty geometry container.

Parameters

[in]	geometry_type	The type of geometry
[out]	geometry	The address of a variable that receives the pointer to the geometry container. The geometry container also implements the IGeometry interface

CreateAttributeCollection()

virtual GDBResult SDK_CALLTYPE CreateAttributeCollection ( IAttributeCollectionEdit **  attribute_collection ) const throw ( )

pure virtual

Creates an empty attribute collection.

Parameters

[out]

attribute_collection

The address of a variable that receives the attribute collection container implements the IAttributeCollection interface

GetGroundingCheckAlerts()

virtual GDBResult SDK_CALLTYPE GetGroundingCheckAlerts ( const SDKAny &  pathname_or_prsp, IGroundingCheckAlerts **  alert_filter  ) const throw ( )

pure virtual

Creates and loads grounding check alert filter.

Parameters

[in]	pathname_or_prsp	Alert groups pathname or PRSP.
[out]	alert_filter	Address of a variable that receives the pointer to the grounding check alert filter.

Returns

kSDKResult_Succeeded or an error if failed

GetFeatureAttributesFilter()

virtual GDBResult SDK_CALLTYPE GetFeatureAttributesFilter ( IFeatureAttributesFilter **  filter ) const throw ( )

pure virtual

Creates a feature attributes filter.

Parameters

[out]

filter

Address of a variable that receives the pointer to the filter.

Returns

kSDKResult_Succeeded or an error if failed

---

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

• gdb_workspace.h