NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
nmea_composer_interface.h
Go to the documentation of this file.
1 #ifndef SDK_ECDIS_NMEA_COMPOSER_INTERFACE_H_
11 #define SDK_ECDIS_NMEA_COMPOSER_INTERFACE_H_
12 #pragma once
13 
14 #include <base/inc/platform.h>
15 #include <base/inc/base_types.h>
16 #include <base/inc/forward_declarations.h>
23 #include <ecdislayer/inc/nmea_parser/cyclic_alert_list_interface.h>
24 
25 SDK_ECDISLAYER_BEGIN_NAMESPACE
26 
27 namespace nmea {
28 
29 FWD_DECL_INTERFACE(INMEAComposer);
30 
34 {
35 };
36 
39 class INMEAComposer : public ISDKProperties
40 {
41  public:
43  virtual INMEASentenceSourceDataSP SDK_CALLTYPE CreateSourceData() const throw() = 0;
44 
46  virtual IRouteDataSP SDK_CALLTYPE CreateRouteData(
47  const SDKUInt32& waypoints_count) const throw() = 0;
48 
50  virtual ICyclicAlertListDataSP SDK_CALLTYPE CreateCyclicAlertListData(
51  const SDKUInt32& alert_entries_count) const throw() = 0;
52 
78  virtual SDKResult SDK_CALLTYPE BuildSentence(
79  const SDKUInt32& sentence_id,
80  const INMEASentenceSourceDataSP& sentence_data,
81  IEnumSDKStringSP& sentences) const throw() = 0;
82 
83  SDK_IMPLEMENT_IID(INMEAComposer)
84  SDK_END_INTERFACE(INMEAComposer)
85 };
86 SDK_DECLARE_IID(INMEAComposer)
87 
88 } // namespace nmea
89 
90 SDK_ECDISLAYER_END_NAMESPACE
91 
92 #endif // SDK_ECDIS_NMEA_COMPOSER_INTERFACE_H_
nmea::INMEAComposer::CreateSourceData
virtual INMEASentenceSourceDataSP SDK_CALLTYPE CreateSourceData() const =0
Creates new NMEA sentence source data container.
route_data_interface.h
Source/parsed single route data container.
nmea::INMEAComposer
NMEA composer for NMEA sentences producing.
Definition: nmea_composer_interface.h:39
base_types.h
SDK base types.
nmea::INMEAComposer::BuildSentence
virtual SDKResult SDK_CALLTYPE BuildSentence(const SDKUInt32 &sentence_id, const INMEASentenceSourceDataSP &sentence_data, IEnumSDKStringSP &sentences) const =0
Builds new NMEA sentence(s) sentence_id - One of SentenceID values sentence_data - Container with app...
properties_interface.h
Object generic properties interface.
nmea::INMEAComposer::CreateRouteData
virtual IRouteDataSP SDK_CALLTYPE CreateRouteData(const SDKUInt32 &waypoints_count) const =0
Creates new route data container.
nmea::NMEAComposerPropertyIDs
NMEAComposerPropertyIDs
Definition: nmea_composer_interface.h:33
ecdislayer_const.h
The ecdislayer constants.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk_component_interface.h
Common base SDK interfaces.
platform.h
Describes the platform constants.
enum_interface.h
Describes a basic enumeration interfaces.
nmea_sentence_source_data_interface.h
A container for source NMEA sentence data fields.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
nmea::INMEAComposer::CreateCyclicAlertListData
virtual ICyclicAlertListDataSP SDK_CALLTYPE CreateCyclicAlertListData(const SDKUInt32 &alert_entries_count) const =0
Creates new cyclic alert list data container.