IGroundingCheckAlerts Class Reference

Grounding check alerts. More...

#include <gdb_workspace.h>

Inheritance diagram for IGroundingCheckAlerts:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetTree (ISDKTreeItem **first_item) const =0
	Returns alert groups tree. More...
virtual SDKResult SDK_CALLTYPE	SetState (SDKUInt32 id, SDKUInt32 state)=0
	Sets alert groups state. More...
virtual SDKResult SDK_CALLTYPE	GetState (SDKUInt32 id, SDKUInt32 &state, SDKUInt32 &indication_id) const =0
	Returns alert groups state. More...
virtual SDKResult SDK_CALLTYPE	GetFeatureState (IFeature *feature, SDKUInt32 &state) const =0
	Returns feature alert groups state. More...
virtual SDKResult SDK_CALLTYPE	ToJSON (SDKString &json) const =0
	Saves current alert group states to the string in JSON format. More...
virtual SDKResult SDK_CALLTYPE	FromJSON (const SDKString &json)=0
	Loads alert group states from the string in JSON format. 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 alerts.

Member Function Documentation

GetTree()

virtual SDKResult SDK_CALLTYPE GetTree ( ISDKTreeItem **  first_item ) const

pure virtual

Returns alert groups tree.

Parameters

[out]

first_item

Reference to the first item.

Returns

SDKResult_Succeeded or an error if fails

SetState()

virtual SDKResult SDK_CALLTYPE SetState ( SDKUInt32  id, SDKUInt32  state  )

pure virtual

Sets alert groups state.

Parameters

[in]	id	Alert group ID.
[in]	state	Alert group state (see GroundingCheckAlertsState enum).

Returns

SDKResult_Succeeded or an error if fails

GetState()

virtual SDKResult SDK_CALLTYPE GetState ( SDKUInt32  id, SDKUInt32 &  state, SDKUInt32 &  indication_id  ) const

pure virtual

Returns alert groups state.

Parameters

[in]	id	Alert group ID.
[out]	indication_id	Indication ID (see GroundingCheckAlertsIndication enum).
[out]	state	Alert group state (see GroundingCheckAlertsState enum).

Returns

SDKResult_Succeeded or an error if fails

GetFeatureState()

virtual SDKResult SDK_CALLTYPE GetFeatureState ( IFeature *  feature, SDKUInt32 &  state  ) const

pure virtual

Returns feature alert groups state.

Parameters

[in]	feature	Reference to the feature.
[out]	state	Alert group state (see GroundingCheckAlertsState enum).

Returns

SDKResult_Succeeded or an error if fails

ToJSON()

virtual SDKResult SDK_CALLTYPE ToJSON ( SDKString &  json ) const

pure virtual

Saves current alert group states to the string in JSON format.

Parameters

[out]

json

Serialized alert group states.

Returns

SDKResult_Succeeded or an error if fails

FromJSON()

virtual SDKResult SDK_CALLTYPE FromJSON ( const SDKString &  json )

pure virtual

Loads alert group states from the string in JSON format.

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_workspace.h