Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions
mrpt::obs::gnss::gnss_message Struct Referenceabstract

Detailed Description

Pure virtual base for all message types.

See also
mrpt::obs::CObservationGPS

Definition at line 24 of file gnss_messages_common.h.

#include <mrpt/obs/gnss_messages_common.h>

Inheritance diagram for mrpt::obs::gnss::gnss_message:
Inheritance graph

Public Member Functions

 gnss_message (gnss_message_type_t msg_type_id)
 
void writeToStream (mrpt::utils::CStream &out) const
 Save to binary stream. Launches an exception upon error.
 
void readFromStream (mrpt::utils::CStream &in)
 Load from binary stream into this existing object. Launches an exception upon error.
 
bool isOfType (const gnss_message_type_t type_id) const
 
template<class MSG_CLASS >
bool isOfClass () const
 
virtual void dumpToStream (mrpt::utils::CStream &out) const =0
 Dumps the contents of the observation in a human-readable form to a given output stream.
 
void dumpToConsole (std::ostream &o=std::cout) const
 Dumps the contents of the observation in a human-readable form to an std::ostream (default=console)
 
virtual bool getAllFieldDescriptions (std::ostream &o) const
 Dumps a header for getAllFieldValues()
 
virtual bool getAllFieldValues (std::ostream &o) const
 Dumps a line with the sequence of all field values (without a line feed at the end).
 
const std::string & getMessageTypeAsString () const
 Returns "NMEA_GGA", etc.
 
virtual ~gnss_message ()
 

Static Public Member Functions

static gnss_messagereadAndBuildFromStream (mrpt::utils::CStream &in)
 Load from binary stream and creates object detecting its type (class factory). Launches an exception upon error.
 
static gnss_messageFactory (const gnss_message_type_t msg_id)
 Creates message.
 
static bool FactoryKnowsMsgType (const gnss_message_type_t msg_id)
 Returns true if Factory() has a registered constructor for this msg type.
 

Public Attributes

gnss_message_type_t message_type
 Type of GNSS message.
 

Protected Member Functions

virtual void internal_writeToStream (mrpt::utils::CStream &out) const =0
 Save to binary stream. Launches an exception upon error.
 
virtual void internal_readFromStream (mrpt::utils::CStream &in)=0
 Save to binary stream. Launches an exception upon error.
 

Constructor & Destructor Documentation

◆ gnss_message()

mrpt::obs::gnss::gnss_message::gnss_message ( gnss_message_type_t  msg_type_id)
inline

Definition at line 27 of file gnss_messages_common.h.

◆ ~gnss_message()

virtual mrpt::obs::gnss::gnss_message::~gnss_message ( )
inlinevirtual

Definition at line 44 of file gnss_messages_common.h.

Member Function Documentation

◆ dumpToConsole()

void mrpt::obs::gnss::gnss_message::dumpToConsole ( std::ostream &  o = std::cout) const

Dumps the contents of the observation in a human-readable form to an std::ostream (default=console)

◆ dumpToStream()

virtual void mrpt::obs::gnss::gnss_message::dumpToStream ( mrpt::utils::CStream out) const
pure virtual

◆ Factory()

static gnss_message * mrpt::obs::gnss::gnss_message::Factory ( const gnss_message_type_t  msg_id)
static

Creates message.

Returns
NULL on unknown msg type

◆ FactoryKnowsMsgType()

static bool mrpt::obs::gnss::gnss_message::FactoryKnowsMsgType ( const gnss_message_type_t  msg_id)
static

Returns true if Factory() has a registered constructor for this msg type.

◆ getAllFieldDescriptions()

virtual bool mrpt::obs::gnss::gnss_message::getAllFieldDescriptions ( std::ostream &  o) const
inlinevirtual

◆ getAllFieldValues()

virtual bool mrpt::obs::gnss::gnss_message::getAllFieldValues ( std::ostream &  o) const
inlinevirtual

Dumps a line with the sequence of all field values (without a line feed at the end).

See also
getAllFieldDescriptions()
Returns
false if not implemented for this message type

Reimplemented in mrpt::obs::gnss::Message_NMEA_GGA, mrpt::obs::gnss::Message_NMEA_GLL, mrpt::obs::gnss::Message_NMEA_RMC, mrpt::obs::gnss::Message_NMEA_VTG, and mrpt::obs::gnss::Message_NMEA_ZDA.

Definition at line 42 of file gnss_messages_common.h.

◆ getMessageTypeAsString()

const std::string & mrpt::obs::gnss::gnss_message::getMessageTypeAsString ( ) const

Returns "NMEA_GGA", etc.

◆ internal_readFromStream()

virtual void mrpt::obs::gnss::gnss_message::internal_readFromStream ( mrpt::utils::CStream in)
protectedpure virtual

◆ internal_writeToStream()

virtual void mrpt::obs::gnss::gnss_message::internal_writeToStream ( mrpt::utils::CStream out) const
protectedpure virtual

◆ isOfClass()

template<class MSG_CLASS >
bool mrpt::obs::gnss::gnss_message::isOfClass ( ) const
inline

Definition at line 33 of file gnss_messages_common.h.

◆ isOfType()

bool mrpt::obs::gnss::gnss_message::isOfType ( const gnss_message_type_t  type_id) const

◆ readAndBuildFromStream()

static gnss_message * mrpt::obs::gnss::gnss_message::readAndBuildFromStream ( mrpt::utils::CStream in)
static

Load from binary stream and creates object detecting its type (class factory). Launches an exception upon error.

◆ readFromStream()

void mrpt::obs::gnss::gnss_message::readFromStream ( mrpt::utils::CStream in)

Load from binary stream into this existing object. Launches an exception upon error.

◆ writeToStream()

void mrpt::obs::gnss::gnss_message::writeToStream ( mrpt::utils::CStream out) const

Save to binary stream. Launches an exception upon error.

Member Data Documentation

◆ message_type

gnss_message_type_t mrpt::obs::gnss::gnss_message::message_type

Type of GNSS message.

Definition at line 25 of file gnss_messages_common.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Wed Mar 22 06:16:42 UTC 2023