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

Provides access to members that can be used to access the individual attributes of a geometry, feature or attribute. More...

#include <gdb_attribute.h>

Inheritance diagram for IAttributeCollection:
ISDKComponent

Public Member Functions

virtual GDBResult SDK_CALLTYPE GetAttributeCount (SDKUInt32 &count) const =0 throw ()
 Returns the number of attributes in the attribute collection. More...
 
virtual GDBResult SDK_CALLTYPE GetAttribute (SDKUInt32 index, IAttribute **attribute)=0 throw ()
 Returns the attribute from the attribute collection specified by index. The first attribute has index 0 and the last attribute has index equal to AttributeCount - 1. More...
 
virtual GDBResult SDK_CALLTYPE FindAttribute (AttributeClassCode class_code, IAttribute **attribute)=0 throw ()
 Finds an attribute specified by the attribute class code. More...
 
virtual GDBResult SDK_CALLTYPE GetAttributeValue (AttributeClassCode class_code, SDKAny &value)=0 throw ()
 Method to return the value of an attribute specified by class. 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 can be used to access the individual attributes of a geometry, feature or attribute.

Member Function Documentation

◆ GetAttributeCount()

virtual GDBResult SDK_CALLTYPE GetAttributeCount ( SDKUInt32 &  count) const
throw (
)
pure virtual

Returns the number of attributes in the attribute collection.

Parameters
[out]countAddress of a variable that receives the number of items in this collection.
Returns
kSDKResult_Succeeded.

◆ GetAttribute()

virtual GDBResult SDK_CALLTYPE GetAttribute ( SDKUInt32  index,
IAttribute **  attribute 
)
throw (
)
pure virtual

Returns the attribute from the attribute collection specified by index. The first attribute has index 0 and the last attribute has index equal to AttributeCount - 1.

Parameters
[in]indexIndex of the attribute in this collection.
[out]attributeAddress of a variable that receives the pointer to the IAttribute interface associated with the attribute.
Returns
SDKResult_Succeeded
SDKResult_InvalidArgument - Indicates an out of range index.

◆ FindAttribute()

virtual GDBResult SDK_CALLTYPE FindAttribute ( AttributeClassCode  class_code,
IAttribute **  attribute 
)
throw (
)
pure virtual

Finds an attribute specified by the attribute class code.

Parameters
class_code[in] The attribute class code.
attribute[out] Address of a variable that receives the IAttribute interface associated with the attribute object.
Returns
kSDKResult_Succeeded
kSDKResult_NotFound - Indicates that the specified class code is not a member of this collection.

◆ GetAttributeValue()

virtual GDBResult SDK_CALLTYPE GetAttributeValue ( AttributeClassCode  class_code,
SDKAny &  value 
)
throw (
)
pure virtual

Method to return the value of an attribute specified by class.

Parameters
class_code[in] The attribute class code.
[out]valueAddress of a variable that receives the attribute value.
Returns
kSDKResult_Succeeded.
kSDKResult_InternalError. Indicates a problem with the data.

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