nmea_parser_interface.h

Go to the documentation of this file.

#ifndef SDK_ECDIS_NMEA_PARSER_INTERFACE_H_
#define SDK_ECDIS_NMEA_PARSER_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <ecdislayer/inc/ecdislayer_const.h>
#include "filters_enumerator_interface.h"
#include "parsed_nmea_sentence_data_interface.h"
 
SDK_ECDISLAYER_BEGIN_NAMESPACE
 
namespace nmea {
 
FWD_DECL_INTERFACE(INMEAParser);
 
// Generic NMEA parser properties
enum NMEAParserPropertyIDs
{
  // Filtering mode for NMEA sentences:
  // There are two modes of NMEA sentences filtering, in case no filters defined
  // via AddSentenceFilter, the NMEA parser will parse ALL of NMEA sentences.
  // In case at least one filter is defined and given property value is set to
  // 1) true: only NMEA sentences, which are satisfies to filtering conditions
  //          will be parsed, in case sentence does not satisfy filtering 
  //          conditions, it will be filtered without parsing
  // 2) false: only NMEA sentences, which are satisfies to filtering conditions
  //           will be filtered, ALL of other sentences will be parsed
  // Example:   Filter is set to GLL mnemonic code only, talker ID is not defined
  // Sentence mnemonic code |        Mode = true          |        Mode = false
  //       GLL              |  Sentence will be parsed    |   Sentence will be filtered
  //       GGA              |  Sentence will be filtered  |   Sentence will be parsed
  kNMEAParserProperty_SentenceFilterMode_ParseOnlyRequested = 0, // kSDKAnyType_Bool
 
  // Filtering mode for checksum checks 
  // (see description above, it's similar to sentence filtering mode)
  kNMEAParserProperty_ChecksumFilterMode_CheckOnlyRequested = 1, // kSDKAnyType_Bool
 
  // Use strict IEC 61162 format check
  kNMEAParserProperty_StrictFormatCheck                     = 2, // kSDKAnyType_Bool
 
  // CRC is mandatory flag
  // If NMEA sentence does not have a CRC and CRC filtering is off for
  // given sentence, this sentence will be rejected with 
  // kParseResult_Failed_AbsentChecksum result
  kNMEAParserProperty_CRCIsMandatory                        = 3, // kSDKAnyType_Bool
};
 
class INMEAParser : public ISDKProperties
{
 public:
  virtual SDKResult SDK_CALLTYPE ParseNMEASentence(
    const SDKString& nmea_sentence,
    IParsedNMEASentenceDataSP& parsed_nmea_sentence_data) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddSentenceFilter(
    const SDKString& talker_id_filter, 
    const SDKString& mnemonic_code_filter) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveSentenceFilter(
    const SDKString& talker_id_filter, 
    const SDKString& mnemonic_code_filter) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetSentenceFilters(
    IFiltersEnumSP& filters_enum) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddChecksumFilter(
    const SDKString& talker_id_filter, 
    const SDKString& mnemonic_code_filter) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveChecksumFilter(
    const SDKString& talker_id_filter, 
    const SDKString& mnemonic_code_filter) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetChecksumFilters(
    IFiltersEnumSP& filters_enum) const throw() = 0;
 
  SDK_IMPLEMENT_IID(INMEAParser)
  SDK_END_INTERFACE(INMEAParser)
};
SDK_DECLARE_IID(INMEAParser)
 
} // namespace nmea
 
SDK_ECDISLAYER_END_NAMESPACE
 
#endif // SDK_ECDIS_NMEA_PARSER_INTERFACE_H_