IOwnShipDeviceConfig Class Reference

Manages the own ship configuration properties. More...

#include <ownship_device_config_interface.h>

Inheritance diagram for IOwnShipDeviceConfig:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetDevicePosition (SDKUInt32 device, double &x, double &y) const =0 throw ()
	Returns relative position of the specified device in meters. More...
virtual SDKResult SDK_CALLTYPE	SetDevicePosition (SDKUInt32 device, double x, double y)=0 throw ()
	Sets relative position of the specified device in meters. More...
virtual SDKResult SDK_CALLTYPE	GetDeviceGeoPosition (SDKUInt32 device, double &x, double &y) const =0 throw ()
	Returns geographic position of the specified device. More...
virtual SDKResult SDK_CALLTYPE	GetDeviceZ (SDKUInt32 device, double &z) const =0 throw ()
	Returns Z coordinate of the specified device in meters. More...
virtual SDKResult SDK_CALLTYPE	SetDeviceZ (SDKUInt32 device, double z)=0 throw ()
	Sets Z coordinate of the specified device in meters. More...
virtual SDKResult SDK_CALLTYPE	GetDeviceError (SDKUInt32 device, SDKUInt32 error_type, double &error_val) const =0 throw ()
	Returns device error. More...
virtual SDKResult SDK_CALLTYPE	SetDeviceError (SDKUInt32 device, SDKUInt32 error_type, double error_val)=0 throw ()
	Sets device error. More...
virtual SDKResult SDK_CALLTYPE	GetDeviceName (SDKUInt32 device, SDKString *name, SDKString *browse_name) const =0 throw ()
	Returns device browse name. 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

Manages the own ship configuration properties.

Member Function Documentation

GetDevicePosition()

virtual SDKResult SDK_CALLTYPE GetDevicePosition ( SDKUInt32  device, double &  x, double &  y  ) const throw ( )

pure virtual

Returns relative position of the specified device in meters.

Parameters

[in]	device	The own ship device.
[out]	x	X coordinate of the device position.
[out]	y	Y coordinate of the device position.

Returns

Ok If succeeded

Err_NotExist

SetDevicePosition()

virtual SDKResult SDK_CALLTYPE SetDevicePosition ( SDKUInt32  device, double  x, double  y  ) throw ( )

pure virtual

Sets relative position of the specified device in meters.

Parameters

[in]	device	The own ship device.
[in]	x	X coordinate of the device position.
[in]	y	Y coordinate of the device position.

Returns

Ok If succeeded

Err_NotExist

GetDeviceGeoPosition()

virtual SDKResult SDK_CALLTYPE GetDeviceGeoPosition ( SDKUInt32  device, double &  x, double &  y  ) const throw ( )

pure virtual

Returns geographic position of the specified device.

Parameters

[in]	device	The own ship device.
[out]	x	Longitude of the device position.
[out]	y	Latitude of the device position.

Returns

Ok If succeeded

Err_NotExist

GetDeviceZ()

virtual SDKResult SDK_CALLTYPE GetDeviceZ ( SDKUInt32  device, double &  z  ) const throw ( )

pure virtual

Returns Z coordinate of the specified device in meters.

Parameters

[in]	device	The own ship device.
[out]	z	Z coordinate of the device.

Returns

Ok If succeeded

Err_NotApplicable

SetDeviceZ()

virtual SDKResult SDK_CALLTYPE SetDeviceZ ( SDKUInt32  device, double  z  ) throw ( )

pure virtual

Sets Z coordinate of the specified device in meters.

Parameters

[in]	device	The own ship device.
[in]	z	Z coordinate of the device.

Returns

Ok If succeeded

Err_NotApplicable

GetDeviceError()

virtual SDKResult SDK_CALLTYPE GetDeviceError ( SDKUInt32  device, SDKUInt32  error_type, double &  error_val  ) const throw ( )

pure virtual

Returns device error.

Parameters

[in]	device	The own ship device.
[in]	error_type	An error type.
[out]	error_val	Address of a variable that receives an error.

Returns

Ok If succeeded

Err_NotApplicable

SetDeviceError()

virtual SDKResult SDK_CALLTYPE SetDeviceError ( SDKUInt32  device, SDKUInt32  error_type, double  error_val  ) throw ( )

pure virtual

Sets device error.

Parameters

[in]	device	The own ship device.
[in]	error_type	An error type.
[in]	error_val	The error value.

Returns

Ok If succeeded

Err_NotApplicable

GetDeviceName()

virtual SDKResult SDK_CALLTYPE GetDeviceName ( SDKUInt32  device, SDKString *  name, SDKString *  browse_name  ) const throw ( )

pure virtual

Returns device browse name.

Parameters

[in]	device	The own ship device.
[out]	name	Address of a variable that receives the device name.
[out]	browse_name	Address of a variable that receives the device browse name.

Returns

Ok If succeeded

Err_NotExist

---

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

• ownship_device_config_interface.h