IVesselWorkspace Class Reference

Provides access to members that manage the vessels workspace. More...

#include <vessels_interface.h>

Inheritance diagram for IVesselWorkspace:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetVesselDataset (const DatasetID &dsid, IVesselDataset **vessel_dataset)=0 throw ()
	Returns the pointer to the IVesselDataset interface associated with the Vessel dataset specified by type. More...
virtual SDKResult SDK_CALLTYPE	GetVessel (const SDKAny &id, const DatasetID &dsid, IVessel **vessel)=0 throw ()
	Returns the pointer to the IVessel interface associated with the Vessel object specified by object id and type. 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 manage the vessels workspace.

Member Function Documentation

GetVesselDataset()

virtual SDKResult SDK_CALLTYPE GetVesselDataset ( const DatasetID &  dsid, IVesselDataset **  vessel_dataset  ) throw ( )

pure virtual

Returns the pointer to the IVesselDataset interface associated with the Vessel dataset specified by type.

Parameters

[in]	dsid	Vessel dataset ID identifier.
[out]	vessel	Address of a variable that receives the pointer to the IVesselDataset interface associated with the specified vessel dataset.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist if there is no vessel dataset with the specified type.

GetVessel()

virtual SDKResult SDK_CALLTYPE GetVessel ( const SDKAny &  id, const DatasetID &  dsid, IVessel **  vessel  ) throw ( )

pure virtual

Returns the pointer to the IVessel interface associated with the Vessel object specified by object id and type.

Parameters

[in]	id	Vessel object identifier.
[in]	dsid	Vessel dataset ID identifier.
[out]	vessel	Address of a variable that receives the pointer to the IVessel interface associated with the specified vessel.

Returns

kSDKResult_Succeeded

kSDKResult_NotExist if there is no vessel with the specified ID.

---

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

• vessels_interface.h