Position fixing. More...

#include <vessels_interface.h>

Inheritance diagram for IPositionFixing:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetAvailableTechnique (PosFixTechnique &technique) const =0 throw ()
	Returns the best available fixing technique. More...

virtual SDKResult SDK_CALLTYPE	CalculateFixedPosition (const SDKTime &time, const SDKGeoPoint &dr_pos, SDKGeoPoint &fixed_pos, FixAdvice &advice, PosFixTechnique &technique)=0 throw ()
	Calculates the fixed position. More...

virtual SDKResult SDK_CALLTYPE	AcceptFixedPosition ()=0 throw ()
	Accept previously calculated fixed position. More...

virtual SDKResult SDK_CALLTYPE	GetConfidenceEllipse (double &a, double &b, double &alpha)=0 throw ()
	Returns the confidence ellipse parameters (if available) for the last observation. More...

virtual SDKResult SDK_CALLTYPE	GetConfidenceCircle (double &r)=0 throw ()
	Returns the radius of confidence circle (if available) for the last observation. More...

virtual SDKResult SDK_CALLTYPE	AddBearing (const SDKTime &time, const SDKGeoPoint &pos_from, double bearing, const SDKGeoPoint &curr_pos, double bearing_error, SDKUInt16 &ref_point_id)=0 throw ()
	Adds bearing data for one LOP. More...

virtual SDKResult SDK_CALLTYPE	AddRunningBearing (SDKUInt16 ref_point_id, const SDKTime &time, double bearing, const SDKGeoPoint &curr_pos, double bearing_error)=0 throw ()
	Adds bearing data for the later LOP (Running fix). More...

virtual SDKResult SDK_CALLTYPE	AddDistance (const SDKTime &time, const SDKGeoPoint &pos_from, double distance, const SDKGeoPoint &curr_pos, double distance_error, SDKUInt16 &ref_point_id)=0 throw ()
	Adds distance data for one LOP. More...

virtual SDKResult SDK_CALLTYPE	AddRunningDistance (SDKUInt16 ref_point_id, const SDKTime &time, double distance, const SDKGeoPoint &curr_pos, double distance_error)=0 throw ()
	Adds distance data for the later LOP (Running fix). More...

virtual SDKResult SDK_CALLTYPE	AddBearingDistance (const SDKTime &time, const SDKGeoPoint &pos_from, double bearing, double distance, const SDKGeoPoint &curr_pos, double bearing_error, double distance_error, SDKUInt16 &ref_point_id)=0 throw ()
	Adds bearing and distance data for one LOP. More...

virtual SDKResult SDK_CALLTYPE	Clear ()=0 throw ()
	Clears stored LOPs.

virtual SDKResult SDK_CALLTYPE	GetPositionFixingWks (IWorkspace **wks)=0 throw ()
	Returns the pointer to the IWorkspace interface. 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

Position fixing.

Member Function Documentation

◆ GetAvailableTechnique()

virtual SDKResult SDK_CALLTYPE GetAvailableTechnique	(	PosFixTechnique &	technique	)	const
throw	(
	)

pure virtual

Returns the best available fixing technique.

Parameters

[out] technique Used position fixing technique or kPosFixTechnique_none if no fixing technique is available.

Returns: SDKResult

◆ CalculateFixedPosition()

virtual SDKResult SDK_CALLTYPE CalculateFixedPosition	(	const SDKTime &	time,
		const SDKGeoPoint &	dr_pos,
		SDKGeoPoint &	fixed_pos,
		FixAdvice &	advice,
		PosFixTechnique &	technique
	)
throw	(
	)

pure virtual

Calculates the fixed position.

Parameters

[in]	time	Time zero for the observation.
[in]	dr_pos	Current (DR) position.
[out]	fixed_pos	Fixed position.
[out]	advice	Advice to accept or not the fixed position.
[out]	technique	Used position fixing technique or kPosFixTechnique_none if no fixing technique is available.

Returns: SDKResult

◆ AcceptFixedPosition()

virtual SDKResult SDK_CALLTYPE AcceptFixedPosition	(	)
throw	(
	)

pure virtual

Accept previously calculated fixed position.

Returns: SDKResult

◆ GetConfidenceEllipse()

virtual SDKResult SDK_CALLTYPE GetConfidenceEllipse	(	double &	a,
		double &	b,
		double &	alpha
	)
throw	(
	)

pure virtual

Returns the confidence ellipse parameters (if available) for the last observation.

Parameters

[out]	a	Semi-major axis of ellipse (in NM).
[out]	b	Semi-minor axis of ellipse (in NM).
[out]	alpha	Orientation of semi-major axis (in degrees).

Returns: false if confidence ellipse is not available.

◆ GetConfidenceCircle()

virtual SDKResult SDK_CALLTYPE GetConfidenceCircle	(	double &	r	)
throw	(
	)

pure virtual

Returns the radius of confidence circle (if available) for the last observation.

Parameters

[out] r Radius of confidence circle (in NM).

Returns: false if confidence circle is not available.

◆ AddBearing()

virtual SDKResult SDK_CALLTYPE AddBearing	(	const SDKTime &	time,
		const SDKGeoPoint &	pos_from,
		double	bearing,
		const SDKGeoPoint &	curr_pos,
		double	bearing_error,
		SDKUInt16 &	ref_point_id
	)
throw	(
	)

pure virtual

Adds bearing data for one LOP.

Parameters

[in]	time	Time stamp.
[in]	pos_from	Position of reference point.
[in]	bearing	Bearing to the reference point.
[in]	curr_pos	Current vessel position at the measurement moment.
[in]	bearing_error	(optional) Bearing parameter error (in degrees).
[out]	ref_point_id	Reference point identifier (>= 1), 0 if failed to add LOP

Returns: SDKResult

◆ AddRunningBearing()

virtual SDKResult SDK_CALLTYPE AddRunningBearing	(	SDKUInt16	ref_point_id,
		const SDKTime &	time,
		double	bearing,
		const SDKGeoPoint &	curr_pos,
		double	bearing_error
	)
throw	(
	)

pure virtual

Adds bearing data for the later LOP (Running fix).

Parameters

[in]	ref_point_id	ID of reference point.
[in]	time	Time stamp.
[in]	bearing	Later bearing to the reference point.
[in]	curr_pos	Current vessel position at the measurement moment.
[in]	bearing_error	(optional) Bearing parameter error (in degrees).

Returns: false if failed to add later LOP.

◆ AddDistance()

virtual SDKResult SDK_CALLTYPE AddDistance	(	const SDKTime &	time,
		const SDKGeoPoint &	pos_from,
		double	distance,
		const SDKGeoPoint &	curr_pos,
		double	distance_error,
		SDKUInt16 &	ref_point_id
	)
throw	(
	)

pure virtual

Adds distance data for one LOP.

Parameters

[in]	time	Time stamp.
[in]	pos_from	Position of reference point.
[in]	distance	Distance to the reference point (in NM).
[in]	curr_pos	Current vessel position at the measurement moment.
[in]	distance_error	(optional) Distance parameter error (in NM).
[out]	ref_point_id	Reference point identifier (>= 1), 0 if failed to add LOP

Returns: SDKResult

◆ AddRunningDistance()

virtual SDKResult SDK_CALLTYPE AddRunningDistance	(	SDKUInt16	ref_point_id,
		const SDKTime &	time,
		double	distance,
		const SDKGeoPoint &	curr_pos,
		double	distance_error
	)
throw	(
	)

pure virtual

Adds distance data for the later LOP (Running fix).

Parameters

[in]	id	ID of the added before LOP.
[in]	time	Time stamp.
[in]	distance	Later distance to the reference point (in NM).
[in]	curr_pos	Current vessel position at the measurement moment.
[in]	distance_error	(optional) Distance parameter error (in NM).

Returns: false if failed to add later LOP.

◆ AddBearingDistance()

virtual SDKResult SDK_CALLTYPE AddBearingDistance	(	const SDKTime &	time,
		const SDKGeoPoint &	pos_from,
		double	bearing,
		double	distance,
		const SDKGeoPoint &	curr_pos,
		double	bearing_error,
		double	distance_error,
		SDKUInt16 &	ref_point_id
	)
throw	(
	)

pure virtual

Adds bearing and distance data for one LOP.

Parameters

[in]	time	Time stamp.
[in]	pos_from	Position of reference point.
[in]	bearing	Bearing to the reference point.
[in]	distance	Distance to the reference point.
[in]	curr_pos	Current vessel position at the measurement moment.
[in]	bearing_error	(optional) Bearing error (in degrees).
[in]	distance_error	(optional) Distance error (in NM).
[out]	ref_point_id	Reference point identifier (>= 1), 0 if failed to add LOP

Returns: SDKResult

◆ GetPositionFixingWks()

virtual SDKResult SDK_CALLTYPE GetPositionFixingWks	(	IWorkspace **	wks	)
throw	(
	)

pure virtual

Returns the pointer to the IWorkspace interface.

Parameters

[out] wks Address of a variable that receives the pointer to the IWorkspace interface.

Returns: kSDKResult_Succeeded

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

vessels_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAvailableTechnique()

◆ CalculateFixedPosition()

◆ AcceptFixedPosition()

◆ GetConfidenceEllipse()

◆ GetConfidenceCircle()

◆ AddBearing()

◆ AddRunningBearing()

◆ AddDistance()

◆ AddRunningDistance()

◆ AddBearingDistance()

◆ GetPositionFixingWks()