Main MRPT website > C++ reference for MRPT 1.3.2
CGPS_NTRIP.h
Go to the documentation of this file.
1 /* +---------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | http://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2015, Individual contributors, see AUTHORS file |
6  | See: http://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See details in http://www.mrpt.org/License |
8  +---------------------------------------------------------------------------+ */
9 
10 #pragma once
11 
15 
16 namespace mrpt
17 {
18  namespace hwdrivers
19  {
20  /** A combination of GPS receiver + NTRIP receiver capable of submitting GGA frames to enable RTCM 3.0.
21  * This class holds instances of two classes, publicly exposed as member variables:
22  * - mrpt::hwdrivers::CGPSInterface gps;
23  * - mrpt::hwdrivers::CNTRIPEmitter ntrip;
24  *
25  * and acts as a "joint sensor", calling both objects' doProcess() inside the doProcess() loop, etc.
26  *
27  * The goal of this class is automatically gather GGA frames from the gps sensor and upload them to the NTRIP server.
28  *
29  * Configuration file format is a combination of the original parameters for both classes, each with
30  * a prefix: "gps_" for CGPSInterface params and "ntrip_" for CNTRIPEmitter.
31  *
32  * \code
33  * PARAMETERS IN THE ".INI"-LIKE CONFIGURATION STRINGS:
34  * -------------------------------------------------------
35  * [supplied_section_name]
36  * gps_COM_port_WIN = COM3
37  * gps_COM_port_LIN = ttyS0
38  * gps_baudRate = 4800 // The baudrate of the communications (typ. 4800 bauds)
39  * gps_pose_x = 0 // 3D position of the sensed point relative to the robot (meters)
40  * gps_pose_y = 0
41  * gps_pose_z = 0
42  * # Other params (see CGPSInterface)
43  *
44  * ntrip_COM_port_WIN = COM1 // Serial port where the NTRIP stream will be dumped to.
45  * ntrip_COM_port_LIN = ttyUSB0
46  * ntrip_baudRate = 38400
47  *
48  * ntrip_server = 143.123.9.129 // NTRIP caster IP
49  * ntrip_port = 2101
50  * ntrip_mountpoint = MYPOINT23
51  * #ntrip_user = pepe // User & password optional.
52  * #ntrip_password = loco
53  *
54  * \endcode
55  *
56  * \note Verbose debug info will be dumped to cout if the environment variable "MRPT_HWDRIVERS_VERBOSE" is set to "1", or if you call CGenericSensor::enableVerbose(true)
57  *
58  * \ingroup mrpt_hwdrivers_grp
59  */
61  {
63 
64  public:
67 
68  /** Constructor. See mrpt::hwdrivers::CGPSInterface for the meaning of params. */
69  CGPS_NTRIP( int BUFFER_LENGTH = 500, mrpt::hwdrivers::CSerialPort *outPort = NULL, mrpt::synch::CCriticalSection *csOutPort = NULL);
70 
71  /** Destructor */
72  virtual ~CGPS_NTRIP();
73 
74  // See docs in parent class
75  void doProcess();
76 
77  virtual void initialize();
78  protected:
79  /** See the class documentation at the top for expected parameters */
80  void loadConfig_sensorSpecific( const mrpt::utils::CConfigFileBase &configSource, const std::string &iniSection );
81  }; // end class
82 
83  } // end namespace
84 } // end namespace
A generic interface for a wide-variety of sensors designed to be used in the application RawLogGrabbe...
This class provides simple critical sections functionality.
A parser of NMEA commands, for connecting to a GPS by a serial port.
Definition: CGPSInterface.h:63
A communications serial port built as an implementation of a utils::CStream.
Definition: CSerialPort.h:43
This class allows loading and storing values and vectors of different types from a configuration text...
mrpt::hwdrivers::CGPSInterface gps
Definition: CGPS_NTRIP.h:65
#define DEFINE_GENERIC_SENSOR(class_name)
This declaration must be inserted in all CGenericSensor classes definition, within the class declarat...
A combination of GPS receiver + NTRIP receiver capable of submitting GGA frames to enable RTCM 3...
Definition: CGPS_NTRIP.h:60
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
#define HWDRIVERS_IMPEXP
This "virtual driver" encapsulates a NTRIP client (see CNTRIPClient) but adds the functionality of du...
Definition: CNTRIPEmitter.h:46
mrpt::hwdrivers::CNTRIPEmitter ntrip
Definition: CGPS_NTRIP.h:66



Page generated by Doxygen 1.8.11 for MRPT 1.3.2 SVN: at Mon May 9 06:50:38 UTC 2016