navtex_interface.h File Reference

Navtex support for ECDIS. More...

#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>

Go to the source code of this file.

Data Structures
class	INavtexFactory
	Navtex factory. More...
class	INavtex
	Navtex database. More...
class	INavtexMessagesEnum
	Navtex messages enumerator. More...
class	INavtexMessage
	Single Navtex message. More...
class	INavtexObjectsEnum
	Navtex objects enumerator. More...
class	INavtexMessageParser
	Parser Navtex message. More...
class	INavtexMessageCoordinates
	Parsed Navtex objects. More...

Typedefs
typedef SDKUInt32	NavtexMessageID
	Navtex message ID.
typedef SDKUInt8	NavtexMessageCode
	Navtex message code.
typedef SDKUInt8	NavtexMessageErrRate
	Navtex message error rate (0%-100%)
typedef SDKUInt64	NavtexMessageFlags
	Available Navtex message flag values.

Enumerations
enum	NavtexFactoryPropertyIDs
	Generic Navtex Factory properties.
enum	NavtexPropertyIDs
	Generic Navtex properties.
enum	NavtexMessagePropertyIDs { kNavtexMessage_ClearParsedObject = 0 }
	Generic Navtex properties. More...
enum	NavtexMessageCoordinatesPropertyIDs { kNavtexMessageCoordinates_Type = 0, kNavtexMessageCoordinates_ExpirationTimeType }
	Navtex message coordinate properties. More...
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' }
	List of known Navtex coverage areas. More...
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' }
	List of known Navtex message types. More...
enum	NavtexMessageFlagValues { kNavtexMessageFlag_NoFlags = 0x0, kNavtexMessageFlag_Important = 0x1, kNavtexMessageFlag_Protected = 0x2, kNavtexMessageFlag_NotExamined = 0x4 }
enum	NavtexMessageCoordinatesType
	Navtex message coordinate type.

Variables
static const NavtexMessageID	kUndefinedNavtexMessageID = 0xFFFFFFFF
	Undefined Navtex message ID.
static const NavtexMessageCode	kUndefinedNavtexMessageCode = 0xFF
	Undefined Navtex message code.
static const NavtexMessageErrRate	kUndefinedNavtexMessageErrRate = 0xFF
	Undefined Navtex message error rate.

Detailed Description

Navtex support for ECDIS.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author

The Open Marine SDK authors

Date

02/2014

Maintenance:

The Open Marine SDK authors

Enumeration Type Documentation

NavtexMessageFlagValues

enum NavtexMessageFlagValues

Enumerator
kNavtexMessageFlag_NoFlags	No message flags.
kNavtexMessageFlag_Important	Given message is important.
kNavtexMessageFlag_Protected	Given message is protected (can't be deleted)
kNavtexMessageFlag_NotExamined	Given message was not examined yet.