apollo::drivers::gnss::Stream Class Reference

#include <stream.h>

Inheritance diagram for apollo::drivers::gnss::Stream:

Collaboration diagram for apollo::drivers::gnss::Stream:

Public Types
enum	Status { Status::DISCONNECTED, Status::CONNECTED, Status::ERROR }

Public Member Functions
virtual	~Stream ()
Status	get_status () const
virtual bool	Connect ()=0
virtual bool	Disconnect ()=0
void	RegisterLoginData (const std::vector< std::string > login_data)
void	Login ()
virtual size_t	read (uint8_t *buffer, size_t max_length)=0
virtual size_t	write (const uint8_t *buffer, size_t length)=0
size_t	write (const std::string &buffer)

Static Public Member Functions
static Stream *	create_tcp (const char *address, uint16_t port, uint32_t timeout_usec=1000000)
static Stream *	create_udp (const char *address, uint16_t port, uint32_t timeout_usec=1000000)
static Stream *	create_serial (const char *device_name, uint32_t baud_rate, uint32_t timeout_usec=0)
static Stream *	create_ntrip (const std::string &address, uint16_t port, const std::string &mountpoint, const std::string &user, const std::string &passwd, uint32_t timeout_s=30)

Static Public Attributes
static constexpr size_t	NUM_STATUS

Protected Member Functions
	Stream ()

Protected Attributes
Status	status_ = Status::DISCONNECTED

Member Enumeration Documentation

Status

enum apollo::drivers::gnss::Stream::Status

strong

Enumerator
DISCONNECTED
CONNECTED
ERROR

Constructor & Destructor Documentation

~Stream()

virtual apollo::drivers::gnss::Stream::~Stream ( )

inlinevirtual

Stream()

apollo::drivers::gnss::Stream::Stream ( )

inlineprotected

Member Function Documentation

Connect()

virtual bool apollo::drivers::gnss::Stream::Connect ( )

pure virtual

Implemented in apollo::drivers::gnss::TcpStream.

create_ntrip()

static Stream* apollo::drivers::gnss::Stream::create_ntrip ( const std::string &  address, uint16_t  port, const std::string &  mountpoint, const std::string &  user, const std::string &  passwd, uint32_t  timeout_s = 30  )

static

create_serial()

static Stream* apollo::drivers::gnss::Stream::create_serial ( const char *  device_name, uint32_t  baud_rate, uint32_t  timeout_usec = 0  )

static

create_tcp()

static Stream* apollo::drivers::gnss::Stream::create_tcp ( const char *  address, uint16_t  port, uint32_t  timeout_usec = 1000000  )

static

create_udp()

static Stream* apollo::drivers::gnss::Stream::create_udp ( const char *  address, uint16_t  port, uint32_t  timeout_usec = 1000000  )

static

Disconnect()

virtual bool apollo::drivers::gnss::Stream::Disconnect ( )

pure virtual

Implemented in apollo::drivers::gnss::TcpStream.

get_status()

Status apollo::drivers::gnss::Stream::get_status ( ) const

inline

Login()

void apollo::drivers::gnss::Stream::Login ( )

inline

read()

virtual size_t apollo::drivers::gnss::Stream::read ( uint8_t *  buffer, size_t  max_length  )

pure virtual

Implemented in apollo::drivers::gnss::TcpStream.

RegisterLoginData()

void apollo::drivers::gnss::Stream::RegisterLoginData ( const std::vector< std::string >  login_data )

inline

write() [1/2]

virtual size_t apollo::drivers::gnss::Stream::write ( const uint8_t *  buffer, size_t  length  )

pure virtual

Implemented in apollo::drivers::gnss::TcpStream.

write() [2/2]

size_t apollo::drivers::gnss::Stream::write ( const std::string &  buffer )

inline

Member Data Documentation

NUM_STATUS

constexpr size_t apollo::drivers::gnss::Stream::NUM_STATUS

static

Initial value:

=
      static_cast<int>(Stream::Status::ERROR) + 1

status_

Status apollo::drivers::gnss::Stream::status_ = Status::DISCONNECTED

protected

---

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

• modules/drivers/gnss/stream/stream.h