mercury::PortHandlerWindows Class Reference

The class for control port in Windows. More...

#include <port_handler_windows.h>

Inheritance diagram for mercury::PortHandlerWindows:

Public Member Functions
	PortHandlerWindows (const char *port_name)
	The function that initializes instance of PortHandler and gets port_name @description The function initializes instance of PortHandler and gets port_name. More...
virtual	~PortHandlerWindows ()
	The function that closes the port @description The function calls PortHandlerWindows::closePort() to close the port. More...
bool	openPort ()
	The function that opens the port @description The function calls PortHandlerWindows::setBaudRate() to open the port. More...
void	closePort ()
	The function that closes the port @description The function closes the port. More...
void	clearPort ()
	The function that clears the port @description The function clears the port. More...
void	setPortName (const char *port_name)
	The function that sets port name into the port handler @description The function sets port name into the port handler. More...
char *	getPortName ()
	The function that returns port name set into the port handler @description The function returns current port name set into the port handler. More...
bool	setBaudRate (const int baudrate)
	The function that sets baudrate into the port handler @description The function sets baudrate into the port handler. More...
int	getBaudRate ()
	The function that returns current baudrate set into the port handler @description The function returns current baudrate set into the port handler. More...
int	getBytesAvailable ()
	The function that checks how much bytes are able to be read from the port buffer @description The function checks how much bytes are able to be read from the port buffer @description and returns the number. More...
int	readPort (uint8_t *packet, int length)
	The function that reads bytes from the port buffer @description The function gets bytes from the port buffer, @description and returns a number of bytes read. More...
int	writePort (uint8_t *packet, int length)
	The function that writes bytes on the port buffer @description The function writes bytes on the port buffer, @description and returns a number of bytes which are successfully written. More...
void	setPacketTimeout (uint16_t packet_length)
	The function that sets and starts stopwatch for watching packet timeout @description The function sets the stopwatch by getting current time and the time of packet timeout with packet_length. More...
void	setPacketTimeout (double msec)
	The function that sets and starts stopwatch for watching packet timeout @description The function sets the stopwatch by getting current time and the time of packet timeout with msec. More...
bool	isPacketTimeout ()
	The function that checks whether packet timeout is occurred @description The function checks whether current time is passed by the time of packet timeout from the time set by PortHandlerWindows::setPacketTimeout(). More...
Public Member Functions inherited from mercury::PortHandler
virtual	~PortHandler ()

Additional Inherited Members
Static Public Member Functions inherited from mercury::PortHandler
static PortHandler *	getPortHandler (const char *port_name)
	The function that gets PortHandler class inheritance @description The function gets class inheritance (PortHandlerLinux / PortHandlerWindows / PortHandlerMac / PortHandlerArduino. More...
Public Attributes inherited from mercury::PortHandler
bool	is_using_
	shows whether the port is in use More...
Static Public Attributes inherited from mercury::PortHandler
static const int	DEFAULT_BAUDRATE_ = 1000000
	Default Baudrate. More...

Detailed Description

The class for control port in Windows.

Definition at line 38 of file port_handler_windows.h.

Constructor & Destructor Documentation

PortHandlerWindows()

mercury::PortHandlerWindows::PortHandlerWindows

(

const char *

port_name

)

The function that initializes instance of PortHandler and gets port_name @description The function initializes instance of PortHandler and gets port_name.

~PortHandlerWindows()

virtual mercury::PortHandlerWindows::~PortHandlerWindows ( )

inlinevirtual

The function that closes the port @description The function calls PortHandlerWindows::closePort() to close the port.

Definition at line 67 of file port_handler_windows.h.

Member Function Documentation

clearPort()

void mercury::PortHandlerWindows::clearPort ( )

virtual

The function that clears the port @description The function clears the port.

Implements mercury::PortHandler.

closePort()

void mercury::PortHandlerWindows::closePort ( )

virtual

The function that closes the port @description The function closes the port.

Implements mercury::PortHandler.

getBaudRate()

int mercury::PortHandlerWindows::getBaudRate ( )

virtual

The function that returns current baudrate set into the port handler @description The function returns current baudrate set into the port handler.

Returns

Baudrate

Implements mercury::PortHandler.

getBytesAvailable()

int mercury::PortHandlerWindows::getBytesAvailable ( )

virtual

The function that checks how much bytes are able to be read from the port buffer @description The function checks how much bytes are able to be read from the port buffer @description and returns the number.

Returns

Length of read-able bytes in the port buffer

Implements mercury::PortHandler.

getPortName()

char* mercury::PortHandlerWindows::getPortName ( )

virtual

The function that returns port name set into the port handler @description The function returns current port name set into the port handler.

Returns

Port name

Implements mercury::PortHandler.

isPacketTimeout()

bool mercury::PortHandlerWindows::isPacketTimeout ( )

virtual

The function that checks whether packet timeout is occurred @description The function checks whether current time is passed by the time of packet timeout from the time set by PortHandlerWindows::setPacketTimeout().

Implements mercury::PortHandler.

openPort()

bool mercury::PortHandlerWindows::openPort ( )

virtual

The function that opens the port @description The function calls PortHandlerWindows::setBaudRate() to open the port.

Returns

communication results which come from PortHandlerWindows::setBaudRate()

Implements mercury::PortHandler.

readPort()

int mercury::PortHandlerWindows::readPort ( uint8_t *  packet, int  length  )

virtual

The function that reads bytes from the port buffer @description The function gets bytes from the port buffer, @description and returns a number of bytes read.

Parameters

packet	Buffer for the packet received
length	Length of the buffer for read

Returns

-1

when error was occurred

or Length of bytes read

Implements mercury::PortHandler.

setBaudRate()

bool mercury::PortHandlerWindows::setBaudRate ( const int  baudrate )

virtual

The function that sets baudrate into the port handler @description The function sets baudrate into the port handler.

Parameters

baudrate

Baudrate

Returns

false

when error was occurred during port opening

or true

Implements mercury::PortHandler.

setPacketTimeout() [1/2]

void mercury::PortHandlerWindows::setPacketTimeout ( double  msec )

virtual

The function that sets and starts stopwatch for watching packet timeout @description The function sets the stopwatch by getting current time and the time of packet timeout with msec.

Parameters

packet_length

Length of the packet expected to be received

Implements mercury::PortHandler.

setPacketTimeout() [2/2]

void mercury::PortHandlerWindows::setPacketTimeout ( uint16_t  packet_length )

virtual

The function that sets and starts stopwatch for watching packet timeout @description The function sets the stopwatch by getting current time and the time of packet timeout with packet_length.

Parameters

packet_length

Length of the packet expected to be received

Implements mercury::PortHandler.

setPortName()

void mercury::PortHandlerWindows::setPortName ( const char *  port_name )

virtual

The function that sets port name into the port handler @description The function sets port name into the port handler.

Parameters

port_name

Port name

Implements mercury::PortHandler.

writePort()

int mercury::PortHandlerWindows::writePort ( uint8_t *  packet, int  length  )

virtual

The function that writes bytes on the port buffer @description The function writes bytes on the port buffer, @description and returns a number of bytes which are successfully written.

Parameters

packet	Buffer which would be written on the port buffer
length	Length of the buffer for write

Returns

-1

when error was occurred

or Length of bytes written

Implements mercury::PortHandler.

---

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

• c++/include/mercury_sdk/port_handler_windows.h