IFeatureAttributesFilter Class Reference

Feature attributes filter. More...

#include <gdb_dataset.h>

Inheritance diagram for IFeatureAttributesFilter:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetPRSP (PRSP &prsp) const =0 throw ()
	Returns PRSP of the filter. More...
virtual SDKResult SDK_CALLTYPE	GetCount (SDKUInt32 &count) const =0 throw ()
	Returns the number of filter items. More...
virtual SDKResult SDK_CALLTYPE	Get (SDKUInt32 index, PRSP &prsp, FeatureClassCode &feature_class_code, AttributeClassCode &attribute_class_code, SDKAny &attribute_value) const =0 throw ()
	Gets the filter item. More...
virtual SDKResult SDK_CALLTYPE	Add (PRSP prsp, FeatureClassCode feature_class_code, AttributeClassCode attribute_class_code, const SDKAny &attribute_value)=0 throw ()
	Adds the new filter item. More...
virtual SDKResult SDK_CALLTYPE	Filter (SDK_GDB_NAMESPACE::IFeature *feature, bool *passes) const =0 throw ()
	Checks if the feature is passing the filter. More...
virtual SDKResult SDK_CALLTYPE	ToJSON (SDKString &json) const =0 throw ()
	Serializes the filter to the JSON string. More...
virtual SDKResult SDK_CALLTYPE	FromJSON (const SDKString &json)=0 throw ()
	De-serializes the JSON string to the 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

Feature attributes filter.

Member Function Documentation

GetPRSP()

virtual SDKResult SDK_CALLTYPE GetPRSP ( PRSP &  prsp ) const throw ( )

pure virtual

Returns PRSP of the filter.

Parameters

[out]

prsp

Gets the PRSP of the filter.

Returns

SDKResult_Succeeded or an error if fails

GetCount()

virtual SDKResult SDK_CALLTYPE GetCount ( SDKUInt32 &  count ) const throw ( )

pure virtual

Returns the number of filter items.

Parameters

[out]

count

Number the filter items.

Returns

SDKResult_Succeeded or an error if fails

Get()

virtual SDKResult SDK_CALLTYPE Get ( SDKUInt32  index, PRSP &  prsp, FeatureClassCode &  feature_class_code, AttributeClassCode &  attribute_class_code, SDKAny &  attribute_value  ) const throw ( )

pure virtual

Gets the filter item.

Parameters

[in]	item	The filter item.
[out]	feature_class_code	Address of a variable that receives the feature class code.
[out]	attribute_class_code	Address of a variable that receives the attribute class code.
[out]	attribute_value	Address of a variable that receives the attribute value.

Returns

SDKResult_Succeeded or an error if fails

Add()

virtual SDKResult SDK_CALLTYPE Add ( PRSP  prsp, FeatureClassCode  feature_class_code, AttributeClassCode  attribute_class_code, const SDKAny &  attribute_value  ) throw ( )

pure virtual

Adds the new filter item.

Parameters

[in]	feature_class_code	The feature class code.
[in]	attribute_class_code	The attribute class code.
[in]	attribute_value	The attribute value.

Returns

SDKResult_Succeeded or an error if fails

Filter()

virtual SDKResult SDK_CALLTYPE Filter ( SDK_GDB_NAMESPACE::IFeature *  feature, bool *  passes  ) const throw ( )

pure virtual

Checks if the feature is passing the filter.

Parameters

[in]	feature	Pointer to the feature to check.
[out]	passes	Address of a variable that gets the check result. return SDKResult_Succeeded or an error if fails

ToJSON()

virtual SDKResult SDK_CALLTYPE ToJSON ( SDKString &  json ) const throw ( )

pure virtual

Serializes the filter to the JSON string.

Parameters

[out]

json

Serialized alert group states.

Returns

SDKResult_Succeeded or an error if fails

FromJSON()

virtual SDKResult SDK_CALLTYPE FromJSON ( const SDKString &  json ) throw ( )

pure virtual

De-serializes the JSON string to the filter.

Parameters

[in]

json

Serialized alert group states.

Returns

SDKResult_Succeeded or an error if fails

---

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

• gdb_dataset.h