OpenCPN Partial API docs
Loading...
Searching...
No Matches
ais_decoder.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2010 by David S. Register *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 **************************************************************************/
17
24#ifndef AIS_DECODER_H_
25#define AIS_DECODER_H_
26
27#include <map>
28#include <unordered_map>
29#include <memory>
30#include <vector>
31
32#include <wx/datetime.h>
33#include <wx/event.h>
34#include <wx/string.h>
35
36#include "rapidjson/fwd.h"
37#include "model/ais_bitstring.h"
38#include "model/ais_defs.h"
40#include "model/comm_navmsg.h"
41#include "model/ocpn_types.h"
42#include "model/select.h"
43#include "model/track.h"
44#include "observable_evtvar.h"
45
46using N0183MsgPtr = std::shared_ptr<const Nmea0183Msg>;
47using N2000MsgPtr = std::shared_ptr<const Nmea2000Msg>;
48using SignalKMsgPtr = std::shared_ptr<const SignalkMsg>;
49using NavMsgPtr = std::shared_ptr<const NavMsg>;
50
51class AisDecoder; // forward
52class ArrayOfMmsiProperties; // forward
53
54// AISTargetAlertDialog in gui layer
55extern wxEvtHandler *g_pais_alert_dialog_active;
56
57extern Select *pSelectAIS;
58extern wxString AISTargetNameFileName;
59extern AisDecoder *g_pAIS;
60extern ArrayOfMmsiProperties g_MMSI_Props_Array;
62extern unsigned g_OwnShipmmsi;
64enum AISAudioSoundType {
65 AISAUDIO_NONE,
66 AISAUDIO_CPA,
67 AISAUDIO_SART,
68 AISAUDIO_DSC
69};
70
71wxString GetShipNameFromFile(int);
72
75public:
76 MmsiProperties() = default;
77
78 explicit MmsiProperties(int mmsi) {
79 Init();
80 MMSI = mmsi;
81 }
82 explicit MmsiProperties(wxString &spec);
83
85
86 wxString Serialize();
87
88 void Init();
89 int MMSI;
90 int TrackType;
91 bool m_bignore;
92 bool m_bMOB;
93 bool m_bVDM;
94 bool m_bFollower;
95 bool m_bPersistentTrack;
96 wxString m_ShipName;
97};
98
99WX_DEFINE_ARRAY_PTR(MmsiProperties *, ArrayOfMmsiProperties);
100
102 std::function<bool()> confirm_stop_track;
103 std::function<int()> get_target_mmsi;
105 : confirm_stop_track([]() { return true; }),
106 get_target_mmsi([]() { return 0; }) {}
107};
108
109class AisDecoder : public wxEvtHandler {
110public:
111 explicit AisDecoder(const AisDecoderCallbacks &callbacks);
112
113 ~AisDecoder() override;
114
115 AisError DecodeN0183(const wxString &str);
116 std::unordered_map<int, std::shared_ptr<AisTargetData>> &GetTargetList() {
117 return AISTargetList;
118 }
119 std::unordered_map<int, std::shared_ptr<AisTargetData>> &
120 GetAreaNoticeSourcesList() {
121 return AIS_AreaNotice_Sources;
122 }
123 std::shared_ptr<AisTargetData> Get_Target_Data_From_MMSI(unsigned mmsi);
124 int GetNumTargets() const { return m_n_targets; }
125 bool IsAISSuppressed() const { return m_bSuppressed; }
126 bool IsAISAlertGeneral() const { return m_bGeneralAlert; }
127 void UpdateMMSItoNameFile(const wxString &mmsi, const wxString &name);
128 wxString GetMMSItoNameEntry(const wxString &mmsi);
129 AisError DecodeSingleVDO(const wxString &str, GenericPosDatEx *pos,
130 wxString *acc);
131 void DeletePersistentTrack(const Track *track);
132 std::map<int, Track *> m_persistent_tracks;
133 bool AIS_AlertPlaying() const { return m_bAIS_AlertPlaying; };
134
140
143
146
149
152
155
156private:
157 void OnTimerAIS(wxTimerEvent &event);
158 void OnTimerDSC(wxTimerEvent &event);
159
160 bool NMEACheckSumOK(const wxString &str);
161 void UpdateAllCPA();
162 void UpdateOneCPA(AisTargetData *ptarget);
163 void UpdateAllAlarms();
164 void UpdateAllTracks();
165 void UpdateOneTrack(AisTargetData *ptarget);
166 std::shared_ptr<AisTargetData> ProcessDSx(const wxString &str,
167 bool b_take_dsc = false);
168
169 void getAISTarget(long mmsi, std::shared_ptr<AisTargetData> &pTargetData,
170 std::shared_ptr<AisTargetData> &pStaleTarget,
171 bool &bnewtarget, int &last_report_ticks, wxDateTime &now);
172 void handleUpdate(const std::shared_ptr<AisTargetData> &pTargetData,
173 bool bnewtarget, const rapidjson::Value &update);
174 void updateItem(const std::shared_ptr<AisTargetData> &pTargetData,
175 bool bnewtarget, const rapidjson::Value &item,
176 wxString &sfixtime) const;
177 void CommitAISTarget(const std::shared_ptr<AisTargetData> &pTargetData,
178 const wxString &str, bool message_valid,
179 bool new_target);
180 void InitCommListeners();
181 bool HandleN0183_AIS(const N0183MsgPtr &n0183_msg);
182 void HandleSignalK(const SignalKMsgPtr &sK_msg);
183
184 bool HandleN2K_129038(const N2000MsgPtr &n2k_msg);
185 bool HandleN2K_129039(const N2000MsgPtr &n2k_msg);
186 bool HandleN2K_129041(const N2000MsgPtr &n2k_msg);
187 bool HandleN2K_129794(const N2000MsgPtr &n2k_msg);
188 bool HandleN2K_129809(const N2000MsgPtr &n2k_msg);
189 bool HandleN2K_129810(const N2000MsgPtr &n2k_msg);
190 bool HandleN2K_129793(const N2000MsgPtr &n2k_msg);
191
192 wxString m_signalk_selfid;
193 std::unordered_map<int, std::shared_ptr<AisTargetData>> AISTargetList;
194 std::unordered_map<int, std::shared_ptr<AisTargetData>>
195 AIS_AreaNotice_Sources;
196 AIS_Target_Name_Hash *AISTargetNamesC;
197 AIS_Target_Name_Hash *AISTargetNamesNC;
198
199 ObservableListener listener_N0183_VDM;
200 ObservableListener listener_N0183_FRPOS;
201 ObservableListener listener_N0183_CDDSC;
202 ObservableListener listener_N0183_CDDSE;
203 ObservableListener listener_N0183_TLL;
204 ObservableListener listener_N0183_TTM;
205 ObservableListener listener_N0183_OSD;
206 ObservableListener listener_N0183_WPL;
207 ObservableListener listener_SignalK;
208
209 ObservableListener listener_N2K_129038;
210 ObservableListener listener_N2K_129039;
211 ObservableListener listener_N2K_129041;
212 ObservableListener listener_N2K_129794;
213 ObservableListener listener_N2K_129809;
214 ObservableListener listener_N2K_129810;
215 ObservableListener listener_N2K_129793;
216
217 bool m_busy;
218 wxTimer TimerAIS;
219 wxFrame *m_parent_frame;
220 AisDecoderCallbacks m_callbacks;
221
222 int nsentences;
223 int isentence;
224 wxString sentence_accumulator;
225 bool m_OK;
226
227 std::shared_ptr<AisTargetData> m_pLatestTargetData;
228
229 bool m_bAIS_Audio_Alert_On;
230 wxTimer m_AIS_Audio_Alert_Timer;
231 int m_n_targets;
232 bool m_bSuppressed;
233 bool m_bGeneralAlert;
234 std::shared_ptr<AisTargetData> m_ptentative_dsctarget;
235 wxTimer m_dsc_timer;
236 wxString m_dsc_last_string;
237 std::vector<int> m_MMSI_MismatchVec;
238
239 bool m_bAIS_AlertPlaying;
240 DECLARE_EVENT_TABLE()
241};
242
243#endif // AIS_DECODER_H_
AIS use bitstring.
Select * pSelectAIS
Global instance.
wxString AISTargetNameFileName
Global instance.
ArrayOfMmsiProperties g_MMSI_Props_Array
Global instance.
unsigned g_OwnShipmmsi
Global instance.
AisDecoder * g_pAIS
Global instance.
General AIS definitions.
AIS target definitions.
EventVar plugin_msg
A JSON message should be sent.
EventVar new_track
Notified on new track creation.
EventVar new_ais_wp
Notified when new AIS wp is created.
EventVar info_update
Notified when AIS user dialogs should update.
EventVar delete_track
Notified when about to delete track.
EventVar touch_state
Notified when gFrame->TouchAISActive() should be invoked.
Generic event handling between MVC Model and Controller based on a shared EventVar variable.
Process incoming AIS messages.
Definition ais_decoder.h:74
Keeps listening over its lifespan, removes itself on destruction.
Definition observable.h:155
Represents a track, which is a series of connected track points.
Definition track.h:117
Raw, undecoded messages definitions.
A common variable shared between producer and consumer which supports Listen() and Notify().
Navigation data types.
Selected route, segment, waypoint, etc.
A generic position and navigation data structure.
Definition ocpn_types.h:68
Recorded track abstraction.