NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications

Navtex manager. More...

Modules

 Class IDs
 Navtex Class IDs.
 

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  NavtexMessageCoordinatesType
 Navtex message coordinate type.
 

Variables

static const NavtexMessageCode kUndefinedNavtexMessageCode = 0xFF
 Undefined Navtex message code.
 
static const NavtexMessageErrRate kUndefinedNavtexMessageErrRate = 0xFF
 Undefined Navtex message error rate.
 

Detailed Description

Navtex manager.

Enumeration Type Documentation

◆ NavtexMessagePropertyIDs

Generic Navtex properties.

Enumerator
kNavtexMessage_ClearParsedObject 

Clear parsed object.

◆ NavtexMessageCoordinatesPropertyIDs

Navtex message coordinate properties.

Enumerator
kNavtexMessageCoordinates_Type 

Geometry type.

kNavtexMessageCoordinates_ExpirationTimeType 

Expired time type.

◆ NavtexCoverageArea

List of known Navtex coverage areas.

Enumerator
kNavtexCoverageArea_Unknown 

Unknown coverage area.

kNavtexCoverageArea_A 

Coverage area A.

kNavtexCoverageArea_B 

Coverage area B.

kNavtexCoverageArea_C 

Coverage area C.

kNavtexCoverageArea_D 

Coverage area D.

kNavtexCoverageArea_E 

Coverage area E.

kNavtexCoverageArea_F 

Coverage area F.

kNavtexCoverageArea_G 

Coverage area G.

kNavtexCoverageArea_H 

Coverage area H.

kNavtexCoverageArea_I 

Coverage area I.

kNavtexCoverageArea_J 

Coverage area J.

kNavtexCoverageArea_K 

Coverage area K.

kNavtexCoverageArea_L 

Coverage area L.

kNavtexCoverageArea_M 

Coverage area M.

kNavtexCoverageArea_N 

Coverage area N.

kNavtexCoverageArea_O 

Coverage area O.

kNavtexCoverageArea_P 

Coverage area P.

kNavtexCoverageArea_Q 

Coverage area Q.

kNavtexCoverageArea_R 

Coverage area R.

kNavtexCoverageArea_S 

Coverage area S.

kNavtexCoverageArea_T 

Coverage area T.

kNavtexCoverageArea_U 

Coverage area U.

kNavtexCoverageArea_V 

Coverage area V.

kNavtexCoverageArea_W 

Coverage area W.

kNavtexCoverageArea_X 

Coverage area X.

kNavtexCoverageArea_Y 

Coverage area Y.

kNavtexCoverageArea_Z 

Coverage area Z.

◆ NavtexMessageType

List of known Navtex message types.

Enumerator
kNavtexMessageType_Unknown 

Unknown Navtex message type.

kNavtexMessageType_NavigationalWarning 

Navigational warning.

kNavtexMessageType_MeteorologicalWarning 

Meteorological warning.

kNavtexMessageType_IceReport 

Ice report.

kNavtexMessageType_SARInfoAndPirateWarning 

Search & rescue information, and pirate warning.

kNavtexMessageType_MeteorologicalForecast 

Meteorological forecast.

kNavtexMessageType_PilotServiceMessage 

Pilot service message.

kNavtexMessageType_AISMessage 

AIS messages.

kNavtexMessageType_LORANMessage 

LORAN message.

kNavtexMessageType_SATNAVMessage 

SATNAV message (i.e. GPS or GLONASS)

kNavtexMessageType_OtherNavAidMessage 

Other electronic navaid message.

kNavtexMessageType_NavWarning_AdditionalToA 

Navigational warning - additional to letter A (Should not be rejected by the receiver)

kNavtexMessageType_TestTransmition 

Test transmissions (UK only - not official)

kNavtexMessageType_NoticeToFisherman 

Notice to fishermen (U.S. only - currently not used)

kNavtexMessageType_Environmental 

Environmental (U.S. only - currently not used)

kNavtexMessageType_SpecialServices 

Special services - allocation by IMO NAVTEX Panel.

kNavtexMessageType_SpecialServices2 

Special services - allocation by IMO NAVTEX Panel.

kNavtexMessageType_NoMessageOnHand 

No message on hand.