 |
NAVTOR SDK
v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
|
|
Go to the documentation of this file.
9 #ifndef SDK_ECDISLAYER_OWNSHIP_INTERFACE_H_
10 #define SDK_ECDISLAYER_OWNSHIP_INTERFACE_H_
14 #include <base/inc/forward_declarations.h>
23 SDK_VESSELS_BEGIN_NAMESPACE
48 const SDKUInt32 kTimePeriod_Undefined = 0;
49 const SDKUInt32 kTimeInterval_Undefined = 0;
71 SDKUInt32 time_period,
72 sdk::geometry::IGeometry** past_track)
throw() = 0;
78 const IPastPositionsSP& positions)
throw() = 0;
85 SDKUInt32 time_interval,
86 sdk::geometry::IGeometry** past_track)
throw() = 0;
93 SDKUInt32 time_period,
94 SDKUInt32 time_interval,
95 IPastPositionsSP& positions)
throw() = 0;
99 SDKUInt32 time_interval,
100 IPastPositionsSP& positions)
throw() = 0;
109 const IDistanceLinesSP& positions)
throw() = 0;
113 IDistanceLinesSP& positions)
throw() = 0;
121 double bow_value,
double stern_value,
double cs_value)
throw() = 0;
129 double& bow_value,
double& stern_value,
double& cs_value)
throw() = 0;
135 const IPastPositionsSP& positions)
throw() = 0;
148 virtual SDKResult SDK_CALLTYPE
Count(SDKUInt32& count)
const throw() = 0;
156 SDKTime& utc)
const throw() = 0;
179 virtual SDKResult SDK_CALLTYPE
Count(SDKUInt32& count)
const noexcept = 0;
191 SDKUInt32& type)
const noexcept = 0;
195 double& distance)
const noexcept = 0;
199 IFeatureSP& feature)
const noexcept = 0;
210 SDK_VESSELS_END_NAMESPACE
212 #endif // SDK_ECDISLAYER_OWNSHIP_INTERFACE_H_
Defines constants for Own Ship.
virtual SDKResult SDK_CALLTYPE GetDistanceLines(IDistanceLinesSP &positions)=0
Returns the ownship distance lines.
virtual SDKResult SDK_CALLTYPE Count(SDKUInt32 &count) const =0
Retrieves the amount of past positions.
Describes interfaces that manages a geometry objects.
virtual SDKResult SDK_CALLTYPE SetPastPositions(const IPastPositionsSP &positions)=0
Sets the past track associated with the Vessel object (overwrites the current track).
virtual SDKResult SDK_CALLTYPE SetSpeedVectors(double bow_value, double stern_value, double cs_value)=0
Sets the ownship speed vectors.
Defines Vessels constants.
Provides access to members that provide information about a OwnShip dataset.
Definition: ownship_interface.h:33
virtual SDKResult SDK_CALLTYPE GetHistoricalPastPositions(SDKUInt32 time_interval, IPastPositionsSP &positions)=0
Returns the historical past positions with the specified interval.
virtual SDKResult SDK_CALLTYPE GetDistance(SDKUInt32 index, double &distance) const noexcept=0
Retrieves the distance in NM.
virtual SDKResult SDK_CALLTYPE GetDestFeature(SDKUInt32 index, IFeatureSP &feature) const noexcept=0
Retrieves the related object.
Common Vessels interface.
Object generic properties interface.
virtual SDKResult SDK_CALLTYPE GetPastPositions(SDKUInt32 time_period, SDKUInt32 time_interval, IPastPositionsSP &positions)=0
Returns the past positions for the specified period and with the specified interval.
Provides access to members that provide information about a VesselDataset.
Definition: vessels_interface.h:68
virtual SDKResult SDK_CALLTYPE Count(SDKUInt32 &count) const noexcept=0
Retrieves the amount of distance lines.
virtual SDKResult SDK_CALLTYPE GetHullPointType(SDKUInt32 index, SDKUInt32 &type) const noexcept=0
Retrieves the hull point type.
virtual SDKResult SDK_CALLTYPE GetHullPointPosition(SDKUInt32 index, SDKGeoPoint &position) const noexcept=0
Retrieves geo-coordinates of the hull point.
virtual SDKResult SDK_CALLTYPE GetDestPointPosition(SDKUInt32 index, SDKGeoPoint &position) const noexcept=0
Retrieves geo-coordinates of the destination point.
virtual SDKResult SDK_CALLTYPE SetDestPointPositionByHPType(SDKUInt32 index, const SDKGeoPoint &position) noexcept=0
Sets geo-coordinates of the destination point.
virtual SDKResult SDK_CALLTYPE GetPastTrack(SDKUInt32 time_period, sdk::geometry::IGeometry **past_track)=0
Returns the past track associated with the Vessel object.
virtual SDKResult SDK_CALLTYPE SetDistanceLines(const IDistanceLinesSP &positions)=0
Sets the ownship distance lines.
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
virtual SDKResult SDK_CALLTYPE GetPosition(SDKGeoPoint &position)=0
Returns the current vessel position.
Geo point in degree units.
Definition: geometry_base_types.h:1727
virtual SDKResult SDK_CALLTYPE GetNextPosition(SDKUInt32 index, SDKUInt32 step_num, SDKGeoPoint &position) const =0
Retrieves the next position.
Common base SDK interfaces.
Common interface for all of vessel objects.
Definition: vessels_interface.h:96
Distance lines enumerator.
Definition: ownship_interface.h:175
virtual SDKResult SDK_CALLTYPE GetPrevPosition(SDKUInt32 index, SDKUInt32 step_num, SDKGeoPoint &position) const =0
Retrieves the previous position.
virtual SDKResult SDK_CALLTYPE SetPosition(const SDKGeoPoint &position)=0
Sets the current vessel position.
Single own ship object.
Definition: ownship_interface.h:53
virtual SDKResult SDK_CALLTYPE GetUniversalTime(SDKUInt32 index, SDKTime &utc) const =0
Retrieves the position universal time.
virtual SDKResult SDK_CALLTYPE ResetPastTrack()=0
Deletes the past track associated with the Vessel object.
virtual SDKResult SDK_CALLTYPE SetHistoricalPastPositions(const IPastPositionsSP &positions)=0
Sets the historical past track.
virtual SDKResult SDK_CALLTYPE GetOwnShipObject(SDKUInt64 id, IOwnShipObject **own_ship_object)=0
Returns the pointer to the IVessel interface associated with the Vessel object specified by id.
virtual SDKResult SDK_CALLTYPE GetHistoricalPastTrack(SDKUInt32 time_interval, sdk::geometry::IGeometry **past_track)=0
Returns the historical past track associated with the Vessel object.
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
virtual SDKResult SDK_CALLTYPE GetPosition(SDKUInt32 index, SDKGeoPoint &position) const =0
Retrieves the position geo-coordinates.
SDK_END_NAMESPACE typedef SDKInt64 SDKTime
Milliseconds from Unix epoch.
Definition: base_types.h:56
virtual SDKResult SDK_CALLTYPE GetSpeedVectors(double &bow_value, double &stern_value, double &cs_value)=0
Returns the ownship speed vectors.
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
Past positions enumerator.
Definition: ownship_interface.h:144