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

Detailed Description

TopCon mmGPS devices: SATS, a generic structure for statistics about tracked satelites and their positions.

See also
mrpt::obs::CObservationGPS

Definition at line 63 of file gnss_messages_topcon.h.

#include <mrpt/obs/gnss_messages_topcon.h>

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

Public Member Functions

 Message_TOPCON_SATS ()
 
void dumpToStream (mrpt::utils::CStream &out) const MRPT_OVERRIDE
 Dumps the contents of the observation in a human-readable form to a given output stream.
 
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
 
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.
 

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

mrpt::vector_byte USIs
 The list of USI (Universal Sat ID) for the detected sats (See GRIL Manual, pag 4-31).
 
mrpt::vector_signed_byte ELs
 Elevation (in degrees, 0-90) for each satellite in USIs.
 
mrpt::vector_signed_word AZs
 Azimuth (in degrees, 0-360) for each satellite in USIs.
 
gnss_message_type_t message_type
 Type of GNSS message.
 

Static Public Attributes

static const gnss_message_type_t msg_type = TOPCON_SATS
 Static msg type (member expected by templates)
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ Message_TOPCON_SATS()

mrpt::obs::gnss::Message_TOPCON_SATS::Message_TOPCON_SATS ( )

Member Function Documentation

◆ dumpToConsole()

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

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

◆ dumpToStream()

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

Dumps the contents of the observation in a human-readable form to a given output stream.

See also
dumpToConsole()

Implements mrpt::obs::gnss::gnss_message.

◆ Factory()

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

Creates message.

Returns
NULL on unknown msg type

◆ FactoryKnowsMsgType()

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

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
inlinevirtualinherited

◆ getAllFieldValues()

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

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
inherited

Returns "NMEA_GGA", etc.

◆ internal_readFromStream()

void mrpt::obs::gnss::Message_TOPCON_SATS::internal_readFromStream ( mrpt::utils::CStream in)
protectedvirtual

Save to binary stream. Launches an exception upon error.

Implements mrpt::obs::gnss::gnss_message.

◆ internal_writeToStream()

void mrpt::obs::gnss::Message_TOPCON_SATS::internal_writeToStream ( mrpt::utils::CStream out) const
protectedvirtual

Save to binary stream. Launches an exception upon error.

Implements mrpt::obs::gnss::gnss_message.

◆ isOfClass()

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

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
inherited

◆ readAndBuildFromStream()

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

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)
inherited

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
inherited

Save to binary stream. Launches an exception upon error.

Member Data Documentation

◆ AZs

mrpt::vector_signed_word mrpt::obs::gnss::Message_TOPCON_SATS::AZs

Azimuth (in degrees, 0-360) for each satellite in USIs.

Definition at line 71 of file gnss_messages_topcon.h.

◆ ELs

mrpt::vector_signed_byte mrpt::obs::gnss::Message_TOPCON_SATS::ELs

Elevation (in degrees, 0-90) for each satellite in USIs.

Definition at line 70 of file gnss_messages_topcon.h.

◆ message_type

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

Type of GNSS message.

Definition at line 25 of file gnss_messages_common.h.

◆ msg_type

const gnss_message_type_t mrpt::obs::gnss::Message_TOPCON_SATS::msg_type = TOPCON_SATS
static

Static msg type (member expected by templates)

Definition at line 65 of file gnss_messages_topcon.h.

◆ USIs

mrpt::vector_byte mrpt::obs::gnss::Message_TOPCON_SATS::USIs

The list of USI (Universal Sat ID) for the detected sats (See GRIL Manual, pag 4-31).

Definition at line 69 of file gnss_messages_topcon.h.




Page generated by Doxygen 1.9.6 for MRPT 1.4.0 SVN: at Fri Jan 20 02:28:26 UTC 2023