GNSS receiver tools  1
Tools for use with GNSS receivers
UBX::Input_message Class Reference

Base class for messages that go to the GPS receiver. More...

#include <UBX.hh>

+ Inheritance diagram for UBX::Input_message:

Public Types

typedef std::shared_ptr< Input_messageptr
 
- Public Types inherited from GNSS::Message
typedef std::shared_ptr< Messageptr
 

Public Member Functions

const Length message_length (void) const
 The total length of the message. More...
 
virtual void to_buf (unsigned char *buffer) const
 Write the message into a buffer. More...
 
- Public Member Functions inherited from UBX::Message
const Class_ID cls (void) const
 Getter method for the message class. More...
 
const uint8_t id (void) const
 Getter method for the message ID. More...
 
- Public Member Functions inherited from GNSS::Message
virtual ~Message ()
 Virtual destructor to force polymorphism. More...
 
template<typename T >
bool isa (void) const
 Check the type of an object. More...
 
template<typename T >
T * cast_as (void)
 Recast this object to another type. More...
 

Protected Member Functions

virtual const Length payload_length (void) const
 The length of the payload (not including message class/ID) More...
 
virtual void body_to_buf (unsigned char *buffer) const
 Write body fields into a pre-allocated buffer. More...
 
 Input_message (Class_ID cls, uint8_t id)
 Constructor from a message class and ID. More...
 
- Protected Member Functions inherited from UBX::Message
 Message (Class_ID cls, uint8_t id)
 Constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from UBX::Message
Class_ID _cls
 
uint8_t _id
 

Detailed Description

Base class for messages that go to the GPS receiver.

Definition at line 173 of file UBX.hh.

Member Typedef Documentation

typedef std::shared_ptr<Input_message> UBX::Input_message::ptr

Definition at line 197 of file UBX.hh.

Constructor & Destructor Documentation

UBX::Input_message::Input_message ( Class_ID  cls,
uint8_t  id 
)
inlineprotected

Constructor from a message class and ID.

Definition at line 182 of file UBX.hh.

Member Function Documentation

virtual void UBX::Input_message::body_to_buf ( unsigned char *  buffer) const
inlineprotectedvirtual

Write body fields into a pre-allocated buffer.

Definition at line 179 of file UBX.hh.

const Length UBX::Input_message::message_length ( void  ) const
inline

The total length of the message.

Definition at line 188 of file UBX.hh.

virtual const Length UBX::Input_message::payload_length ( void  ) const
inlineprotectedvirtual

The length of the payload (not including message class/ID)

Definition at line 176 of file UBX.hh.

void UBX::Input_message::to_buf ( unsigned char *  buffer) const
virtual

Write the message into a buffer.

Parameters
bufferPointer to a buffer, allocated and freed by the caller. Use message_length() to know how big the buffer needs to be.

Definition at line 53 of file UBX.cc.


The documentation for this class was generated from the following files: