IRelationship Class Reference

Provides access to members that return information about the relationship.
More...

#include <gdb_relationship.h>

Inheritance diagram for IRelationship:

Public Member Functions
virtual GDBResult SDK_CALLTYPE	GetOwner (IObject **owner) const =0 throw ()
	Returns the owner of the relationship. More...
virtual GDBResult SDK_CALLTYPE	GetRelated (IObject **object) const =0 throw ()
	Returns the related object. More...
virtual GDBResult SDK_CALLTYPE	GetRelationshipRole (RelationshipRole &role) const =0 throw ()
	Returns the relationship role. More...
virtual GDBResult SDK_CALLTYPE	GetRelationshipClass (RelationshipClass &rel_class) const =0 throw ()
	Returns the relationship class. Besides the RelationshipClass enum the relationship class is encoded in the Feature Catalog. More...
Public Member Functions inherited from IObject
virtual GDBResult SDK_CALLTYPE	GetObjectID (ObjectID &oid) const =0 throw ()
	Returns the identifier of the object.
virtual GDBResult SDK_CALLTYPE	GetObjectType (ObjectType &type) const =0 throw ()
	Returns the type of the object.
virtual GDBResult SDK_CALLTYPE	GetObjectClassCode (ClassCode &code) const =0 throw ()
	Returns an identifier for the class code.
virtual GDBResult SDK_CALLTYPE	GetObjectPRSP (PRSP &prsp) const =0 throw ()
	returns the product specification identifier of the object.
virtual GDBResult SDK_CALLTYPE	GetRelationships (RelationshipClass relationship_class, RelationshipRole role, IRelationshipCollection **relationship)=0 throw ()
	Returns relationships that this object is a member of. More...
virtual GDBResult SDK_CALLTYPE	GetAttributes (IAttributeCollection **attributes)=0 throw ()
	Returns the attribute collection of the object. More...
virtual GDBResult SDK_CALLTYPE	GetFlags (SDKUInt64 &flags) const =0 throw ()
	Returns The object flags. For the feature object see FEATS_TRP_FLAGS, for the geometry object see GDBGeometryFlags for other object types of see the corresponded flags.
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 about the relationship.

Member Function Documentation

GetOwner()

virtual GDBResult SDK_CALLTYPE GetOwner ( IObject **  owner ) const throw ( )

pure virtual

Returns the owner of the relationship.

Parameters

[out]

owner

Address of a variable that receives the pointer to the IObject interface associated with the object.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

SDKResult_InvalidArgument

kSDKResult_NotExist

GetRelated()

virtual GDBResult SDK_CALLTYPE GetRelated ( IObject **  object ) const throw ( )

pure virtual

Returns the related object.

Parameters

[out]

object

Address of a variable that receives the pointer to the IObject interface associated with the related object.

Returns

kSDKResult_Succeeded

kSDKResult_NotImplemented

SDKResult_InvalidArgument

kSDKResult_NotExist

GetRelationshipRole()

virtual GDBResult SDK_CALLTYPE GetRelationshipRole ( RelationshipRole &  role ) const throw ( )

pure virtual

Returns the relationship role.

Parameters

[out]

role

Address of a variable that receives the relationship role. /return kSDKResult_Succeeded

GetRelationshipClass()

virtual GDBResult SDK_CALLTYPE GetRelationshipClass ( RelationshipClass &  rel_class ) const throw ( )

pure virtual

Returns the relationship class. Besides the RelationshipClass enum the relationship class is encoded in the Feature Catalog.

Parameters

[out]

rel_class

Address of a variable that receives the relationship class.

Returns

kSDKResult_Succeeded

---

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

• gdb_relationship.h