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

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

#include <SkyTraqBin.hh>

+ Inheritance diagram for SkyTraqBin::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 Payload_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 SkyTraqBin::Message
const uint8_t message_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 Payload_length body_length (void) const
 The length of the body (not including message ID or sub-ID) More...
 
virtual void body_to_buf (unsigned char *buffer) const
 Write body fields into a pre-allocated buffer. More...
 
 Input_message (uint8_t id)
 Constructor from a message ID. More...
 
- Protected Member Functions inherited from SkyTraqBin::Message
 Message (uint8_t id)
 Constructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from SkyTraqBin::Message
uint8_t _msg_id
 

Detailed Description

Base class for messages that go to the GPS receiver.

Definition at line 129 of file SkyTraqBin.hh.

Member Typedef Documentation

Definition at line 153 of file SkyTraqBin.hh.

Constructor & Destructor Documentation

SkyTraqBin::Input_message::Input_message ( uint8_t  id)
inlineprotected

Constructor from a message ID.

Definition at line 138 of file SkyTraqBin.hh.

Member Function Documentation

virtual const Payload_length SkyTraqBin::Input_message::body_length ( void  ) const
inlineprotectedvirtual

The length of the body (not including message ID or sub-ID)

Reimplemented in SkyTraqBin::Input_message_with_subid.

Definition at line 132 of file SkyTraqBin.hh.

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

Write body fields into a pre-allocated buffer.

Reimplemented in SkyTraqBin::Input_message_with_subid.

Definition at line 135 of file SkyTraqBin.hh.

const Payload_length SkyTraqBin::Input_message::message_length ( void  ) const
inline

The total length of the message.

Definition at line 144 of file SkyTraqBin.hh.

void SkyTraqBin::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.

Reimplemented in SkyTraqBin::Input_message_with_subid.

Definition at line 52 of file SkyTraqBin.cc.


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