Single own ship object. More...

#include <ownship_interface.h>

Inheritance diagram for IOwnShipObject:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	SetPosition (const SDKGeoPoint &position)=0 throw ()
	Sets the current vessel position. More...

virtual SDKResult SDK_CALLTYPE	GetPosition (SDKGeoPoint &position)=0 throw ()
	Returns the current vessel position. More...

virtual SDKResult SDK_CALLTYPE	GetPastTrack (SDKUInt32 time_period, sdk::geometry::IGeometry **past_track)=0 throw ()
	Returns the past track associated with the Vessel object. More...

virtual SDKResult SDK_CALLTYPE	SetHistoricalPastPositions (const IPastPositionsSP &positions)=0 throw ()
	Sets the historical past track. More...

virtual SDKResult SDK_CALLTYPE	GetHistoricalPastTrack (SDKUInt32 time_interval, sdk::geometry::IGeometry **past_track)=0 throw ()
	Returns the historical past track associated with the Vessel object. More...

virtual SDKResult SDK_CALLTYPE	GetPastPositions (SDKUInt32 time_period, SDKUInt32 time_interval, IPastPositionsSP &positions)=0 throw ()
	Returns the past positions for the specified period and with the specified interval. More...

virtual SDKResult SDK_CALLTYPE	GetHistoricalPastPositions (SDKUInt32 time_interval, IPastPositionsSP &positions)=0 throw ()
	Returns the historical past positions with the specified interval.

virtual SDKResult SDK_CALLTYPE	ResetPastTrack ()=0 throw ()
	Deletes the past track associated with the Vessel object.

virtual SDKResult SDK_CALLTYPE	SetDistanceLines (const IDistanceLinesSP &positions)=0 throw ()
	Sets the ownship distance lines. More...

virtual SDKResult SDK_CALLTYPE	GetDistanceLines (IDistanceLinesSP &positions)=0 throw ()
	Returns the ownship distance lines.

virtual SDKResult SDK_CALLTYPE	SetSpeedVectors (double bow_value, double stern_value, double cs_value)=0 throw ()
	Sets the ownship speed vectors. More...

virtual SDKResult SDK_CALLTYPE	GetSpeedVectors (double &bow_value, double &stern_value, double &cs_value)=0 throw ()
	Returns the ownship speed vectors. More...

virtual SDKResult SDK_CALLTYPE	SetPastPositions (const IPastPositionsSP &positions)=0 throw ()
	Sets the past track associated with the Vessel object (overwrites the current track). More...

Public Member Functions inherited from IVessel
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

Single own ship object.

Member Function Documentation

◆ SetPosition()

virtual SDKResult SDK_CALLTYPE SetPosition	(	const SDKGeoPoint &	position	)
throw	(
	)

pure virtual

Sets the current vessel position.

Parameters

[in] position Geographic position in degrees.

Returns: kSDKResult_Succeeded

◆ GetPosition()

virtual SDKResult SDK_CALLTYPE GetPosition	(	SDKGeoPoint &	position	)
throw	(
	)

pure virtual

Returns the current vessel position.

Parameters

[out] position Geographic position in degrees.

Returns: kSDKResult_Succeeded

◆ GetPastTrack()

virtual SDKResult SDK_CALLTYPE GetPastTrack	(	SDKUInt32	time_period,
		sdk::geometry::IGeometry **	past_track
	)
throw	(
	)

pure virtual

Returns the past track associated with the Vessel object.

Parameters

[out] Address of a variable that receives the pointer to the IGeometry interface associated with the past track geometry object.

◆ SetHistoricalPastPositions()

virtual SDKResult SDK_CALLTYPE SetHistoricalPastPositions	(	const IPastPositionsSP &	positions	)
throw	(
	)

pure virtual

Sets the historical past track.

Parameters

[in] position Geographic position in degrees.

Returns: kSDKResult_Succeeded

◆ GetHistoricalPastTrack()

virtual SDKResult SDK_CALLTYPE GetHistoricalPastTrack	(	SDKUInt32	time_interval,
		sdk::geometry::IGeometry **	past_track
	)
throw	(
	)

pure virtual

Returns the historical past track associated with the Vessel object.

Parameters

[out] Address of a variable that receives the pointer to the IGeometry interface associated with the past track geometry object.

◆ GetPastPositions()

virtual SDKResult SDK_CALLTYPE GetPastPositions	(	SDKUInt32	time_period,
		SDKUInt32	time_interval,
		IPastPositionsSP &	positions
	)
throw	(
	)

pure virtual

Returns the past positions for the specified period and with the specified interval.

Returns: kSDKResult_Succeeded if past positions obtained kSDKResult_EmptyValue if no past positions exist

◆ SetDistanceLines()

virtual SDKResult SDK_CALLTYPE SetDistanceLines	(	const IDistanceLinesSP &	positions	)
throw	(
	)

pure virtual

Sets the ownship distance lines.

Parameters

[in] distance_lines Ownship distance lines.

Returns: kSDKResult_Succeeded

◆ SetSpeedVectors()

virtual SDKResult SDK_CALLTYPE SetSpeedVectors	(	double	bow_value,
		double	stern_value,
		double	cs_value
	)
throw	(
	)

pure virtual

Sets the ownship speed vectors.

Parameters

[in]	bow_value	Bow vector value.
[in]	bow_value	Stern vector value.
[in]	bow_value	CS vector value.

Returns: kSDKResult_Succeeded

◆ GetSpeedVectors()

virtual SDKResult SDK_CALLTYPE GetSpeedVectors	(	double &	bow_value,
		double &	stern_value,
		double &	cs_value
	)
throw	(
	)

pure virtual

Returns the ownship speed vectors.

Parameters

[out]	bow_value	Bow vector value.
[out]	bow_value	Stern vector value.
[out]	bow_value	CS vector value.

Returns: kSDKResult_Succeeded

◆ SetPastPositions()

virtual SDKResult SDK_CALLTYPE SetPastPositions	(	const IPastPositionsSP &	positions	)
throw	(
	)

pure virtual

Sets the past track associated with the Vessel object (overwrites the current track).

Parameters

[in] positions Reference to the positions container.

Returns: kSDKResult_Succeeded

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

ownship_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ SetPosition()

◆ GetPosition()

◆ GetPastTrack()

◆ SetHistoricalPastPositions()

◆ GetHistoricalPastTrack()

◆ GetPastPositions()

◆ SetDistanceLines()

◆ SetSpeedVectors()

◆ GetSpeedVectors()

◆ SetPastPositions()