Changeset 375 in ntrip for trunk/BNC

Timestamp:

Jan 22, 2007, 7:01:19 PM (18 years ago)

Author:

weber

Message:

* empty log message *

Location:

trunk/BNC

Files:

• bncabout.html (modified) (1 diff)
• bnchelp.html (modified) (1 diff)
• bnctabledlg.cpp (modified) (3 diffs)
• bncwindow.cpp (modified) (6 diffs)

trunk/BNC/bncabout.html

@@ -21 +21 @@
 The BKG may not be held liable for damages of any kind, direct or consequential, which may result from the use of this software.<br>
 <br>
-BKG, Frankfurt, Germany, September 2006<br>
+BKG, Frankfurt, Germany, January 2007<br>
 E-Mail: <a><u>euref-ip@bkg.bund.de</u></a>.<br>
 </p>

trunk/BNC/bnchelp.html

@@ -105 +105 @@
 help contents.<br>
 You may keep the 'Help Contents' window open while setting BNC options.
+<br>
+Furthermore, BNC comes with a help system providing online information about its functionality and usage. Simple descriptions are available for any widget. The default way to enter the so-called "What's this?" mode for asking question is to move the focus to the relevant widget and press Shift+F1. A help text appears immediately; it goes away as soon as the user does something else. Some dialogs provide a "?" button that users can click to enter "What's This?" mode; they then click the relevant widget to pop up the "What's This?" window.
 </li> 
 <li>

trunk/BNC/bnctabledlg.cpp

@@ -56 +56 @@
   int ww = QFontMetrics(_casterHostLineEdit->font()).width('w');
   _casterHostLineEdit->setMaximumWidth(18*ww);
+  _casterHostLineEdit->setWhatsThis(tr("Enter the NTRIP broadcaster host IP name or number and port number. <u>http://www.rtcm-ntrip.org/home</u> provides information about known NTRIP broadcaster installations. Note that EUREF and IGS operate NTRIP broadcasters at <u>http://www.euref-ip.net/home</u> and <u>http://www.igs-ip.net/home</u>."));
   _casterPortLineEdit     = new QLineEdit(settings.value("casterPort").toString());
   _casterPortLineEdit->setMaximumWidth(9*ww);
+  _casterPortLineEdit->setWhatsThis(tr("Enter the NTRIP broadcaster host IP name or number and port number. <u>http://www.rtcm-ntrip.org/home</u> provides information about known NTRIP broadcaster installations. Note that EUREF and IGS operate NTRIP broadcasters at <u>http://www.euref-ip.net/home</u> and <u>http://www.igs-ip.net/home</u>."));
   _casterUserLineEdit     = new QLineEdit(settings.value("casterUser").toString());
   _casterUserLineEdit->setMaximumWidth(9*ww);
+  _casterUserLineEdit->setWhatsThis(tr("Streams on NTRIP broadcasters might be protected by password. Enter a valid 'User' ID and 'Password' for access to protected NTRIP broadcaster streams. Accounts are usually provided per NTRIP broadcaster through a registration procedure. Register through <u>http://igs.bkg.bund.de/index_ntrip_reg.htm</u> for access to protected streams on <u>www.euref-ip.net</u> and <u>www.igs-ip.net</u>."));
   _casterPasswordLineEdit = new QLineEdit(settings.value("casterPassword").toString());
   _casterPasswordLineEdit->setMaximumWidth(9*ww);
   _casterPasswordLineEdit->setEchoMode(QLineEdit::Password);
+  _casterPasswordLineEdit->setWhatsThis(tr("Streams on NTRIP broadcasters might be protected by password. Enter a valid 'User' ID and 'Password' for access to protected NTRIP broadcaster streams. Accounts are usually provided per NTRIP broadcaster through a registration procedure. Register through <u>http://igs.bkg.bund.de/index_ntrip_reg.htm</u> for access to protected streams on <u>www.euref-ip.net</u> and <u>www.igs-ip.net</u>."));
 
   QGridLayout* editLayout = new QGridLayout;
@@ -77 +81 @@
 
   _table = new QTableWidget(this);
+  _table->setWhatsThis(tr("<p>Hit button 'Get Table' to download the source-table from the NTRIP broadcaster. Select your streams line by line, use +Shift and +Ctrl when necessary. Hit 'OK' to return to the main window.</p><p>Pay attention to data fields 'format' and 'format-details'. Keep in mind that BNC can only decode and convert streams that come in RTCM 2.x, RTCM 3, or RTIGS formats. RTCM 2.x streams must contain message types 18 and 19 while RTCM 3 streams must contain GPS message types 1002 or 1004 and may contain GLONASS message types 1010 or 1012, see data field 'format-details' for available message types and their repetition rates in brackets.</p><p>The contents of data field 'type' tells you whether a stream comes from a physical Reference Station (RS) or a Virtual Reference Station (VRS).</p>"));
   connect(_table, SIGNAL(itemSelectionChanged()),
           this, SLOT(slotSelectionChanged()));
@@ -240 +245 @@
 
     int ww = QFontMetrics(this->font()).width('w');
-    _table->horizontalHeader()->resizeSection(0,9*ww);
+    _table->horizontalHeader()->resizeSection(0,10*ww);
     _table->horizontalHeader()->resizeSection(2,8*ww);
     _table->horizontalHeader()->resizeSection(3,15*ww);

trunk/BNC/bncwindow.cpp

@@ -60 +60 @@
 
   setMinimumSize(77*ww, 65*ww);
+
   setWindowTitle(tr("BKG Ntrip Client (BNC), Version 1.1b"));
 
@@ -127 +128 @@
   _proxyHostLineEdit  = new QLineEdit(settings.value("proxyHost").toString());
   _proxyHostLineEdit->setMaximumWidth(12*ww);
+  _proxyHostLineEdit->setWhatsThis(tr("<p>You may like to run BNC in a Local Area Network (LAN). LANs are often protected by a proxy server. Enter your proxy server host IP name or number and port number in case one is operated in front of BNC. If you don't know the IP and port of your proxy server, check out the proxy server settings of your Internet browser or ask your network administrator.</p><p>Note that IP streaming may generally be denied in a LAN. In such a case you need to ask your network administrator for an appropriate modification of his security policy or for the installation of a TCP relay to involved NTRIP broadcasters. If that doesn't work out, run BNC outside your LAN on a host that is connected to the Internet through an Internet Service Provider (ISP).</p>"));
   _proxyPortLineEdit  = new QLineEdit(settings.value("proxyPort").toString());
   _proxyPortLineEdit->setMaximumWidth(9*ww);
+  _proxyPortLineEdit->setWhatsThis(tr("<p>You may like to run BNC in a Local Area Network (LAN). LANs are often protected by a proxy server. Enter your proxy server host IP name or number and port number in case one is operated in front of BNC. If you don't know the IP and port of your proxy server, check out the proxy server settings of your Internet browser or ask your network administrator.</p><p>Note that IP streaming may generally be denied in a LAN. In such a case you need to ask your network administrator for an appropriate modification of his security policy or for the installation of a TCP relay to involved NTRIP broadcasters. If that doesn't work out, run BNC outside your LAN on a host that is connected to the Internet through an Internet Service Provider (ISP).</p>"));
   _waitTimeSpinBox   = new QSpinBox();
   _waitTimeSpinBox->setMinimum(1);
@@ -136 +139 @@
   _waitTimeSpinBox->setMaximumWidth(9*ww);
   _waitTimeSpinBox->setValue(settings.value("waitTime").toInt());
+  _waitTimeSpinBox->setWhatsThis(tr("<p>BNC lets you output synchronized observations epoch by epoch. When feeding a real-time GNSS engine waiting for input, BNC ignores whatever is received later than 'Wait for full epoch' seconds. A value of 3 to 5 seconds could be an appropriate choice for that, depending on the latency of the incoming streams and the delay you can accept for your real-time GNSS product.</p><p>Default value for 'Wait for full epoch' is 1 second. Note that 'Wait for full epoch' does not influence the RINEX file contents. Observations received later than 'Wait for full epoch' seconds will still be included in the RINEX files.</p>"));
   _outFileLineEdit    = new QLineEdit(settings.value("outFile").toString());
+  _outFileLineEdit->setWhatsThis(tr("<p>Enter the full path for a file to save synchronized observations in a plain ASCII format.</p><p>Default value is an empty option field, meaning that no ASCII output file is created.</p>"));
   _outPortLineEdit    = new QLineEdit(settings.value("outPort").toString());
   _outPortLineEdit->setMaximumWidth(9*ww);
+  _outPortLineEdit->setWhatsThis(tr("<p>BNC makes synchronized observations available in a binary format on your local host (IP 127.0.0.1) through an IP port. Enter an IP port number to activate this function.</p><p>Default is an empty option field, meaning that no binary outputis generated.</p>"));
   _rnxPathLineEdit    = new QLineEdit(settings.value("rnxPath").toString());
+_rnxPathLineEdit->setWhatsThis(tr("<p>Observations can be converted to RINEX Version 2.11. Enter a path for saving the RINEX files in a directory. If this directory does not exist, BNC will not create RINEX files.</p><p>Default value for 'RINEX directory' is an empty option field, meaning that streams are not converted to RINEX.</p>"));
   _rnxScrpLineEdit    = new QLineEdit(settings.value("rnxScript").toString());
+_rnxScrpLineEdit->setWhatsThis(tr("<p>Whenever a RINEX file is saved, you may like to compress, copy or upload it immediately via FTP. For that you enter the full path of a script or batch file which is then called to carry out these operations. The RINEX file path will be passed to the script as a command line parameter (%1 on Windows systems, $1 on Unix/Linux systems).</p><p>The triggering event for calling the script or batch file is the end of a RINEX file interval. If that is superposedby a stream outage, the triggering event is the stream reconnect.</p>"));
   _rnxSkelLineEdit    = new QLineEdit(settings.value("rnxSkel").toString());
   _rnxSkelLineEdit->setMaximumWidth(5*ww);
+  _rnxSkelLineEdit->setWhatsThis(tr("<p>Whenever BNC generates a new RINEX file, it first tries to retrieve information needed for RINEX headers from so-called public RINEX header skeleton files which are derived from sitelogs. However, it may happen that public RINEX header skeleton files are not available, its contents is not up to date, or you need to have additional/optional records in the RINEX header.</p><p>For that BNC allows to introduce personal skeleton files that contain the header records you would like to see. You may derive a personal RINEX header skeleton file from the information given in an up to date sitelog. A file in the 'RINEX directory' with the extension 'RINEX skeleton extension' is interpreted by BNC as a personal RINEX header skeleton file for the affected stream.</p>"));
   _rnxAppendCheckBox  = new QCheckBox();
   _rnxAppendCheckBox->setCheckState(Qt::CheckState(
                                     settings.value("rnxAppend").toInt()));
+  _rnxAppendCheckBox->setWhatsThis(tr("When starting BNC, new RINEX files are created by default. Probably existing files will be overwritten. However, it may be desirable to append observations to already existing RINEX files following a restart of BNC after an intentional 'Stop', a system crash or a crash of BNC. Hit 'Append files' to continue with already existing files and thus save what has been recorded so far. Note that option 'Append files' also concerns the 'ASCII output file' and the 'Log' file."));
   _rnxIntrComboBox    = new QComboBox();
   _rnxIntrComboBox->setMaximumWidth(9*ww);
@@ -155 +165 @@
   }
   _rnxSamplSpinBox    = new QSpinBox();
+  _rnxSamplSpinBox->setWhatsThis(tr("<p>Select the RINEX sample interval in seconds. Zero '0' stands for converting all incoming epochs to RINEX.</p><p>Default for RINEX 'Sampling' is '0'.</p>"));
   _rnxSamplSpinBox->setMinimum(0);
   _rnxSamplSpinBox->setMaximum(60);
@@ -162 +173 @@
   _rnxSamplSpinBox->setSuffix(" sec");
   _logFileLineEdit    = new QLineEdit(settings.value("logFile").toString());
+  _logFileLineEdit->setWhatsThis(tr("<p>BNC's run-time comments as shown in the 'Log' section can be saved in a file through entering the full path for a 'Log' file.</p><p>Default value for 'Log' is an empty option field, meaning that BNC's run-time comments are not saved in a file.</p>"));
   _mountPointsTable   = new QTableWidget(0,7);
+  _mountPointsTable->setWhatsThis(tr("<p>Streams selected for retrieval are listed in the 'Mountpoints' section. Button 'Add Mountpoints' opens a window that allows you to select data streams from an NTRIP broadcaster by their mountpoints. To delete a stream, select it by mouse click and hit 'Delete Mountpoints'. For adding or deleting several streams simultaneously, highlight them using +Shift and +Ctrl.</p><p>BNC automatically selects one out of several internal decoders for a stream based on its 'format' and 'format-details' as given in the source-table. It may happen that you need to overrule the automated decoder selection. Therefore BNC allows to edit the decoder string (first double-click, then edit field 'decoder', then hit Enter). Decoder strings allowed to be introduced are 'RTCM_2.x', 'RTCM_3', and 'RTIGS'.</p><p>BNC allows to retrieve streams from Virtual Reference Stations. Whether a stream comes from a physical Reference Station (RS) or a Virtual Reference Station (VRS) is indicated in column 'type'. For retrieving a VRS stream, an approximate rover position is required to be send in NMEA format to the NTRIP broadcaster. In return, an individual user-specific data stream is generated, usually by a network RTK software. This stream is tailored exactly to the latitude and longitude shown in the 'lat' and 'long' columns. You may change these values (first double-click, then edit fields 'lat' and/or 'long', then hit Enter) according to your needs. The position has to be introduced in northern latitude degrees (example for northern hemisphere: 52.436, example for eastern hemisphere: -24.567) and eastern longitude degrees (example: 358.872 or -1.128). Editing the 'lat' and 'long' values is only possible for VRS streams. The position must point to a location within the service area of the affected RTK network.<p>"));
+
   _mountPointsTable->horizontalHeader()->resizeSection(1,25*ww);
   _mountPointsTable->horizontalHeader()->resizeSection(2,9*ww);
@@ -238 +252 @@
   _log->setReadOnly(true);
 
+  _log->setWhatsThis(tr("BNC comments its activities in the 'Log' section. Information is given on the communication between BNC and the NTRIP broadcaster as well as on problems that may occur concerning communication link, stream availability, stream delay, stream conversion etc."));
+
   layout->addWidget(new QLabel("Proxy host"),                    0, 0, 1, 2);
   layout->addWidget(_proxyHostLineEdit,                          0, 2);