NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IAttributeNode Class Referenceabstract

Provides access to members that return information for the attribute tree.
More...

#include <gdb_attribute.h>

Inheritance diagram for IAttributeNode:
ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE GetParent (IAttributeNode **parent) const =0 throw ()
 Returns the parent node. More...
 
virtual GDBResult SDK_CALLTYPE GetFirstChild (ClassCode class_code, IAttributeNode **node) const =0 throw ()
 Returns the first child for the node. More...
 
virtual GDBResult SDK_CALLTYPE GetNextChild (ClassCode class_code, IAttributeNode **node) const =0 throw ()
 Returns the next child for the node. More...
 
virtual GDBResult SDK_CALLTYPE ResetChildIterator ()=0 throw ()
 Resets child iterator. 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 return information for the attribute tree.

Member Function Documentation

◆ GetParent()

virtual GDBResult SDK_CALLTYPE GetParent ( IAttributeNode **  parent) const
throw (
)
pure virtual

Returns the parent node.

Parameters
[out]parentAddress of a variable that receives the pointer to the IAttributeNode interface associated with the parent node.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument
kSDKResult_NotExist

◆ GetFirstChild()

virtual GDBResult SDK_CALLTYPE GetFirstChild ( ClassCode  class_code,
IAttributeNode **  node 
) const
throw (
)
pure virtual

Returns the first child for the node.

Parameters
[in]class_codeAn attribute class code to search for. The kAnyClassCode indicates that the class code is ignored in the search.
[out]nodeAddress of a variable that receives the pointer to the IAttributeNode interface associated with the child node.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument
kSDKResult_NotExist

◆ GetNextChild()

virtual GDBResult SDK_CALLTYPE GetNextChild ( ClassCode  class_code,
IAttributeNode **  node 
) const
throw (
)
pure virtual

Returns the next child for the node.

Parameters
class_code[in] An attribute class code to search for. kAnyClassCode is supported.
[out]nodeAddress of a variable that receives the pointer to the IAttributeNode interface associated with the next child node. The kAnyClassCode indicates that the class code is ignored in the search.
Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument
kSDKResult_NotExist

◆ ResetChildIterator()

virtual GDBResult SDK_CALLTYPE ResetChildIterator ( )
throw (
)
pure virtual

Resets child iterator.

Returns
kSDKResult_Succeeded
kSDKResult_InvalidArgument
kSDKResult_NotExist

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