IGroundingCheckResult Class Reference

Grounding check result. More...

#include <gdb_workspace.h>

Inheritance diagram for IGroundingCheckResult:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetFeatures (IEnumFeature **features) const =0 throw ()
	Returns an enumeration of the features. More...
virtual GDBResult SDK_CALLTYPE	GetFeaturesByIndex (SDKUInt32 index, IEnumFeature **features, geometry::IGeometry **zone_geometry) const =0 throw ()
	Returns an enumeration of the features and a zone geometry by zone index. More...
virtual GDBResult SDK_CALLTYPE	SetFeatures (SDKUInt32 index, IEnumFeature *features, geometry::IGeometry *zone_geometry)=0 throw ()
	Set features and a zone geometry by zone index. More...
virtual GDBResult SDK_CALLTYPE	AppendFeatures (SDKUInt32 index, IEnumFeature *features)=0 throw ()
	Append features and a zone geometry by zone index. More...
virtual GDBResult SDK_CALLTYPE	RemoveFeatures (SDKUInt32 index, SDKUInt32 count)=0 throw ()
	Remove features and a zone geometry by zone index. More...
virtual GDBResult SDK_CALLTYPE	GetUsedDatasets (IEnumDataset **datasets) const =0 throw ()
	Returns an enumeration of the datasets. More...
virtual GDBResult SDK_CALLTYPE	SetAlertsFilter (IGroundingCheckAlerts *alerts_filter)=0 throw ()
	Set grounding check alerts 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

Grounding check result.

Member Function Documentation

GetFeatures()

virtual GDBResult SDK_CALLTYPE GetFeatures ( IEnumFeature **  features ) const throw ( )

pure virtual

Returns an enumeration of the features.

Parameters

[out]

features

Address of a variable that receives the pointer to the IEnumFeature interface associated with the grounding check feature enumeration object.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

GetFeaturesByIndex()

virtual GDBResult SDK_CALLTYPE GetFeaturesByIndex ( SDKUInt32  index, IEnumFeature **  features, geometry::IGeometry **  zone_geometry  ) const throw ( )

pure virtual

Returns an enumeration of the features and a zone geometry by zone index.

Parameters

[in]	index	SDKUInt32 associated with the index.
[out]	features	Address of a variable that receives the pointer to the IEnumFeature interface associated with the grounding check feature enumeration object.
[out]	zone_geometry	Address of a variable that receives the pointer to the IGeometry interface associated with the grounding check zone.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

SetFeatures()

virtual GDBResult SDK_CALLTYPE SetFeatures ( SDKUInt32  index, IEnumFeature *  features, geometry::IGeometry *  zone_geometry  ) throw ( )

pure virtual

Set features and a zone geometry by zone index.

Parameters

[in]	index	SDKUInt32 associated with the index.
[in]	features	Pointer to the IEnumFeature interface associated with the feature enum.
[in]	zone_geometry	Pointer to the IGeometry interface associated with the geometry object.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

AppendFeatures()

virtual GDBResult SDK_CALLTYPE AppendFeatures ( SDKUInt32  index, IEnumFeature *  features  ) throw ( )

pure virtual

Append features and a zone geometry by zone index.

Parameters

[in]	index	SDKUInt32 associated with the index.
[in]	features	Pointer to the IEnumFeature interface associated with the feature enum.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

RemoveFeatures()

virtual GDBResult SDK_CALLTYPE RemoveFeatures ( SDKUInt32  index, SDKUInt32  count  ) throw ( )

pure virtual

Remove features and a zone geometry by zone index.

Parameters

[in]	index	SDKUInt32 associated with the index.
[in]	index	SDKUInt32 associated with the count.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

GetUsedDatasets()

virtual GDBResult SDK_CALLTYPE GetUsedDatasets ( IEnumDataset **  datasets ) const throw ( )

pure virtual

Returns an enumeration of the datasets.

Parameters

[out]

datasets

Address of a variable that receives the pointer to the IEnumDataset interface associated with the datasets used for grounding check

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

SetAlertsFilter()

virtual GDBResult SDK_CALLTYPE SetAlertsFilter ( IGroundingCheckAlerts *  alerts_filter ) throw ( )

pure virtual

Set grounding check alerts filter.

Parameters

[in]

alert_filter

Pointer to the IGroundingCheckAlerts interface associated with the grounding check alerts filter.

Returns

SDKResult_Succeeded

SDKResult_NotImplemented

SDKResult_NotExist

---

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

• gdb_workspace.h