bitrl::boards::arduino::ArduinoConnectorUSBBase Class Reference

#include <arduino_connector_usb_base.h>

Inheritance diagram for bitrl::boards::arduino::ArduinoConnectorUSBBase:

Collaboration diagram for bitrl::boards::arduino::ArduinoConnectorUSBBase:

Public Types
typedef ArduinoConnectorBase	base_type
	The base type.

Public Member Functions
	ArduinoConnectorUSBBase (const std::string &port)
std::string	port_name () const noexcept
void	connect () override
	Connect to the Arduino board.
virtual void	close_connection () override
	Close the connection.
std::string	send_cmd (const ArduinoCMDBase &cmd) override
	Send the command.
int_t	port_id () const noexcept
bool	is_port_open () const noexcept
Public Member Functions inherited from bitrl::boards::arduino::ArduinoConnectorBase
virtual	~ArduinoConnectorBase ()=default
	Destructor.

Protected Member Functions
virtual void	open_port_ ()
	Opens the port.
virtual void	configure_port_ ()
	Configure the serial port.
void	set_port_id_ (int_t port_id) noexcept
Protected Member Functions inherited from bitrl::boards::arduino::ArduinoConnectorBase
	ArduinoConnectorBase ()=default
	Constructor.

Member Typedef Documentation

base_type

typedef ArduinoConnectorBase bitrl::boards::arduino::ArduinoConnectorUSBBase::base_type

The base type.

Constructor & Destructor Documentation

ArduinoConnectorUSBBase()

bitrl::boards::arduino::ArduinoConnectorUSBBase::ArduinoConnectorUSBBase

(

const std::string &

port

)

Constructor

Parameters

port
cidx
name

Member Function Documentation

close_connection()

void bitrl::boards::arduino::ArduinoConnectorUSBBase::close_connection ( )

overridevirtual

Close the connection.

Implements bitrl::boards::arduino::ArduinoConnectorBase.

configure_port_()

void bitrl::boards::arduino::ArduinoConnectorUSBBase::configure_port_ ( )

protectedvirtual

Configure the serial port.

connect()

void bitrl::boards::arduino::ArduinoConnectorUSBBase::connect ( )

overridevirtual

Connect to the Arduino board.

Implements bitrl::boards::arduino::ArduinoConnectorBase.

is_port_open()

bool bitrl::boards::arduino::ArduinoConnectorUSBBase::is_port_open ( ) const

inlinenoexcept

Returns

Trur is the port is open

open_port_()

void bitrl::boards::arduino::ArduinoConnectorUSBBase::open_port_ ( )

protectedvirtual

Opens the port.

port_id()

int_t bitrl::boards::arduino::ArduinoConnectorUSBBase::port_id ( ) const

inlinenoexcept

Returns

The port id

port_name()

std::string bitrl::boards::arduino::ArduinoConnectorUSBBase::port_name ( ) const

inlinenoexcept

Returns

string representing the port name

send_cmd()

std::string bitrl::boards::arduino::ArduinoConnectorUSBBase::send_cmd ( const ArduinoCMDBase &  cmd )

overridevirtual

Send the command.

Implements bitrl::boards::arduino::ArduinoConnectorBase.

set_port_id_()

void bitrl::boards::arduino::ArduinoConnectorUSBBase::set_port_id_ ( int_t  port_id )

inlineprotectednoexcept

---

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

• libs/bitrl/src/bitrl/boards/arduino/arduino_connector_usb_base.h
• libs/bitrl/src/bitrl/boards/arduino/arduino_connector_usb_base.cpp