IVessel Class Reference

Common interface for all of vessel objects. More...

#include <vessels_interface.h>

Inheritance diagram for IVessel:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	SetAttributeValue (SDKUInt32 id, const SDKAny &value)=0 throw ()
	Sets the value of the specified vessel attribute. More...
virtual SDKResult SDK_CALLTYPE	GetAttributeValue (SDKUInt32 id, SDKAny &value)=0 throw ()
	Gets the value of the specified vessel attribute. 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

Common interface for all of vessel objects.

Member Function Documentation

SetAttributeValue()

virtual SDKResult SDK_CALLTYPE SetAttributeValue ( SDKUInt32  id, const SDKAny &  value  ) throw ( )

pure virtual

Sets the value of the specified vessel attribute.

Parameters

[in]	id	Vessel attribute identifier.
[in]	value	The attribute value.

Returns

kSDKResult_Succeeded

GetAttributeValue()

virtual SDKResult SDK_CALLTYPE GetAttributeValue ( SDKUInt32  id, SDKAny &  value  ) throw ( )

pure virtual

Gets the value of the specified vessel attribute.

Parameters

[in]	id	Vessel attribute identifier.
[in]	value	Variable which stores the attribute value.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist if there is no attribute with the specified ID.

---

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

• vessels_interface.h