navtex_interface.h

Go to the documentation of this file.

#ifndef SDK_ECDIS_NAVTEX_INTERFACE_H_
#define SDK_ECDIS_NAVTEX_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 <base/inc/geometry/geometry_base_types.h>
#include <ecdislayer/inc/ecdislayer_const.h>
#include <ecdislayer/inc/nmea_parser/parsed_nmea_sentence_data_interface.h>
#include <ecdislayer/inc/nmea_parser/parsed_nmea_sentence_value_ids.h>
 
SDK_NAVTEX_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(INavtexFactory);
FWD_DECL_INTERFACE(INavtex);
FWD_DECL_INTERFACE(INavtexMessagesEnum);
FWD_DECL_INTERFACE(INavtexMessage);
FWD_DECL_INTERFACE(INavtexObjectsEnum);
FWD_DECL_INTERFACE(INavtexMessageParser);
FWD_DECL_INTERFACE(INavtexMessageCoordinates);
 
typedef enum NavtexFactoryPropertyIDs
{
} NavtexFactoryPropertyIDs;
 
typedef enum NavtexPropertyIDs
{
} NavtexPropertyIDs;
 
typedef enum NavtexMessagePropertyIDs
{
  kNavtexMessage_ClearParsedObject = 0,
} NavtexMessagePropertyIDs;
 
typedef enum NavtexMessageCoordinatesPropertyIDs
{
  kNavtexMessageCoordinates_Type = 0, 
  kNavtexMessageCoordinates_ExpirationTimeType, 
} NavtexMessageCoordinatesPropertyIDs;
 
typedef SDKUInt32 NavtexMessageID;
static const NavtexMessageID kUndefinedNavtexMessageID = 0xFFFFFFFF;
 
enum NavtexCoverageArea
{
  kNavtexCoverageArea_Unknown = '\0', 
  kNavtexCoverageArea_A       = 'A',  
  kNavtexCoverageArea_B       = 'B',  
  kNavtexCoverageArea_C       = 'C',  
  kNavtexCoverageArea_D       = 'D',  
  kNavtexCoverageArea_E       = 'E',  
  kNavtexCoverageArea_F       = 'F',  
  kNavtexCoverageArea_G       = 'G',  
  kNavtexCoverageArea_H       = 'H',  
  kNavtexCoverageArea_I       = 'I',  
  kNavtexCoverageArea_J       = 'J',  
  kNavtexCoverageArea_K       = 'K',  
  kNavtexCoverageArea_L       = 'L',  
  kNavtexCoverageArea_M       = 'M',  
  kNavtexCoverageArea_N       = 'N',  
  kNavtexCoverageArea_O       = 'O',  
  kNavtexCoverageArea_P       = 'P',  
  kNavtexCoverageArea_Q       = 'Q',  
  kNavtexCoverageArea_R       = 'R',  
  kNavtexCoverageArea_S       = 'S',  
  kNavtexCoverageArea_T       = 'T',  
  kNavtexCoverageArea_U       = 'U',  
  kNavtexCoverageArea_V       = 'V',  
  kNavtexCoverageArea_W       = 'W',  
  kNavtexCoverageArea_X       = 'X',  
  kNavtexCoverageArea_Y       = 'Y',  
  kNavtexCoverageArea_Z       = 'Z',  
};
 
enum NavtexMessageType
{
  kNavtexMessageType_Unknown                  = '\0', 
  kNavtexMessageType_NavigationalWarning      = 'A',  
  kNavtexMessageType_MeteorologicalWarning    = 'B',  
  kNavtexMessageType_IceReport                = 'C',  
  kNavtexMessageType_SARInfoAndPirateWarning  = 'D',  
  kNavtexMessageType_MeteorologicalForecast   = 'E',  
  kNavtexMessageType_PilotServiceMessage      = 'F',  
  kNavtexMessageType_AISMessage               = 'G',  
  kNavtexMessageType_LORANMessage             = 'H',  
  kNavtexMessageType_SATNAVMessage            = 'J',  
  kNavtexMessageType_OtherNavAidMessage       = 'K',  
  kNavtexMessageType_NavWarning_AdditionalToA = 'L',  
  kNavtexMessageType_TestTransmition          = 'T',  
  kNavtexMessageType_NoticeToFisherman        = 'V',  
  kNavtexMessageType_Environmental            = 'W',  
  kNavtexMessageType_SpecialServices          = 'X',  
  kNavtexMessageType_SpecialServices2         = 'Y',  
  kNavtexMessageType_NoMessageOnHand          = 'Z',  
};
 
typedef SDKUInt8 NavtexMessageCode;
static const NavtexMessageCode kUndefinedNavtexMessageCode = 0xFF;
 
typedef SDKUInt8 NavtexMessageErrRate;
static const NavtexMessageErrRate kUndefinedNavtexMessageErrRate = 0xFF;
 
typedef SDKUInt64 NavtexMessageFlags;
enum NavtexMessageFlagValues
{
  kNavtexMessageFlag_NoFlags     = 0x0, 
  kNavtexMessageFlag_Important   = 0x1, 
  kNavtexMessageFlag_Protected   = 0x2, 
  kNavtexMessageFlag_NotExamined = 0x4, 
};
 
enum NavtexMessageCoordinatesType
{
  kNavtexMessageCoordinates_TypeUnknown = 0,
  kNavtexMessageCoordinates_TypePoint,
  kNavtexMessageCoordinates_TypeLine,
  kNavtexMessageCoordinates_TypeArea,
  kNavtexMessageCoordinates_TypeMultipoint,
  kNavtexMessageCoordinates_TypeCircle,
};
 
class INavtexFactory : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Open(
    const SDKString& path, INavtexSP& navtex) throw() = 0;
 
  SDK_IMPLEMENT_IID(INavtexFactory)
  SDK_END_INTERFACE(INavtexFactory)
};
SDK_DECLARE_IID(INavtexFactory)
 
class INavtex : public ISDKProperties
{
 public:
  virtual SDKResult SDK_CALLTYPE AddMessage(
    const SDK_NMEA_NAMESPACE::IParsedNMEASentenceDataSP& parsed_nmea_data,
    NavtexMessageID& new_navtex_message_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessage(
    const NavtexMessageID& message_id, INavtexMessageSP& message) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessages(
    const NavtexCoverageArea& cov_area_filter, 
    const NavtexMessageType& msg_type_filter,
    const NavtexMessageCode& msg_code_filter,
    const SDKTime& msg_time_filter,
    const NavtexMessageErrRate& err_rate_filter,
    INavtexMessagesEnumSP& msg_enum) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveMessage(
    const NavtexMessageID& message_id) throw() = 0;
 
  SDK_IMPLEMENT_IID(INavtex)
  SDK_END_INTERFACE(INavtex)
};
SDK_DECLARE_IID(INavtex)
 
class INavtexMessagesEnum : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Next(INavtexMessageSP& msg) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetCount(
    SDKUInt32& messages_count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessage(
    const SDKUInt32& message_index, INavtexMessageSP& msg) const throw() = 0;
 
  SDK_IMPLEMENT_IID(INavtexMessagesEnum)
  SDK_END_INTERFACE(INavtexMessagesEnum)
};
SDK_DECLARE_IID(INavtexMessagesEnum)
 
class INavtexMessage : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetMessageID(
    NavtexMessageID& message_id) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetCoverageArea(
    NavtexCoverageArea& coverage_area) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessageType(
    NavtexMessageType& message_type) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessageCode(
    NavtexMessageCode& message_code) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetFrequencyIndicator(
    SDK_NMEA_NAMESPACE::FrequencyIndicator& frequency_indicator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessageTime(
    SDKTime& message_time) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessageErrorRate(
    NavtexMessageErrRate& error_rate) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessage(
    SDKString& message) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetMessageFlags(
    NavtexMessageFlags& message_flags) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetMessageFlags(
    const NavtexMessageFlags& message_flags) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetObjects(
    INavtexObjectsEnumSP& objects) const throw() = 0;
 
 
  SDK_IMPLEMENT_IID(INavtexMessage)
  SDK_END_INTERFACE(INavtexMessage)
};
SDK_DECLARE_IID(INavtexMessage)
 
class INavtexObjectsEnum : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(INavtexMessageCoordinatesSP& msg) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  SDK_IMPLEMENT_IID(INavtexObjectsEnum)
    SDK_END_INTERFACE(INavtexObjectsEnum)
};
SDK_DECLARE_IID(INavtexObjectsEnum)
 
class INavtexMessageParser : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Parse(const SDKString& message) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetCount(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetObject(SDKUInt32 index, 
    INavtexMessageCoordinatesSP& object) const throw() = 0;
 
  SDK_IMPLEMENT_IID(INavtexMessageParser)
  SDK_END_INTERFACE(INavtexMessageParser)
};
SDK_DECLARE_IID(INavtexMessageParser)
 
 
class INavtexMessageCoordinates : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetCount(
    SDKUInt32& points_count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPoint(
    const SDKUInt32& point_idx, SDKGeoPoint& geo_point,
    SDKUInt32* lat_first_pos, SDKUInt32* lat_last_pos, 
    SDKUInt32* lon_first_pos, SDKUInt32* lon_last_pos) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetExpirationDate(SDKAny& date,
    SDKUInt32* date_first_pos, SDKUInt32* date_last_pos) const throw() = 0;
 
  SDK_IMPLEMENT_IID(INavtexMessageCoordinates)
  SDK_END_INTERFACE(INavtexMessageCoordinates)
};
SDK_DECLARE_IID(INavtexMessageCoordinates)
 
SDK_NAVTEX_END_NAMESPACE
 
#endif // SDK_ECDIS_NAVTEX_INTERFACE_H_