serial: Export a serial sensor. More...

#include <ServerSerial/ServerSerial.h>

Inheritance diagram for ServerSerial:

Public Member Functions
	ServerSerial ()=default

	ServerSerial (const ServerSerial &)=delete

	ServerSerial (ServerSerial &&)=delete

ServerSerial &	operator= (const ServerSerial &)=delete

ServerSerial &	operator= (ServerSerial &&)=delete

	~ServerSerial () override

bool	send (const Bottle &msg) override
	Sends a string of chars to the serial communications channel. More...

bool	send (char *msg, size_t size) override

bool	receive (Bottle &msg) override
	Gets the existing chars in the receive queue. More...

int	receiveChar (char &c) override
	Gets one single char from the receive queue. More...

int	flush () override
	Flushes the internal buffer. More...

int	receiveLine (char *line, const int MaxLineLength) override
	Gets one line (a sequence of chars with a ending '\n' or '\r') from the receive queue. More...

int	receiveBytes (unsigned char *bytes, const int size) override
	Gets an array of bytes (unsigned char) with size <= 'size' parameter. More...

bool	setDTR (bool enable) override
	Enable/Disable DTR protocol. More...

virtual bool	open ()
	Default open() method. More...

bool	close () override
	Close the device driver by deallocating all resources and closing ports. More...

bool	open (Searchable &prop) override
	Open the device driver. More...

void	run () override
	The thread main loop deals with writing on ports here. More...

Public Member Functions inherited from yarp::dev::DeviceDriver
	~DeviceDriver () override=default
	Destructor. More...

template<class T >
bool	view (T *&x)
	Get an interface to the device driver. More...

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others. More...

Public Member Functions inherited from yarp::os::IConfig
virtual	~IConfig ()
	Destructor. More...

virtual bool	configure (Searchable &config)
	Change online parameters. More...

Public Member Functions inherited from yarp::dev::ISerialDevice
virtual	~ISerialDevice ()

Detailed Description

serial: Export a serial sensor.

The network interface is composed by two ports. The input port accepts bottles and sends their contents as text to the serial port. The output port streams out whatever information it gets in the serial port as text bottles.

Definition at line 71 of file ServerSerial.h.

Constructor & Destructor Documentation

◆ ServerSerial() [1/3]

ServerSerial::ServerSerial ( )

default

◆ ServerSerial() [2/3]

ServerSerial::ServerSerial ( const ServerSerial & )

delete

◆ ServerSerial() [3/3]

ServerSerial::ServerSerial ( ServerSerial && )

delete

◆ ~ServerSerial()

ServerSerial::~ServerSerial ( )

override

Definition at line 20 of file ServerSerial.cpp.

Member Function Documentation

◆ close()

bool ServerSerial::close ( )

overridevirtual

Close the device driver by deallocating all resources and closing ports.

Returns: true if successful or false otherwise.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 108 of file ServerSerial.cpp.

◆ flush()

int ServerSerial::flush ( )

overridevirtual

Flushes the internal buffer.

Returns: the number of flushed characters.

Implements yarp::dev::ISerialDevice.

Definition at line 68 of file ServerSerial.cpp.

◆ open() [1/2]

bool ServerSerial::open ( )

virtual

Default open() method.

Returns: always false since initialization requires certain parameters.

Definition at line 104 of file ServerSerial.cpp.

◆ open() [2/2]

bool ServerSerial::open ( Searchable & prop )

overridevirtual

Open the device driver.

Parameters

prop	is a Searchable object that contains the parameters to use. Allowed parameters are: verbose or v to print diagnostic information while running, name to specify the prefix of the port names and all parameters requied by the wrapped device driver.

Returns: true iff the object could be configured.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 112 of file ServerSerial.cpp.

◆ operator=() [1/2]

ServerSerial& ServerSerial::operator= ( const ServerSerial & )

delete

◆ operator=() [2/2]

ServerSerial& ServerSerial::operator= ( ServerSerial && )

delete

◆ receive()

bool ServerSerial::receive ( Bottle & msg )

overridevirtual

Gets the existing chars in the receive queue.

Parameters

msg	the received string

Returns: true on success; false if no messages available

Implements yarp::dev::ISerialDevice.

Definition at line 49 of file ServerSerial.cpp.

◆ receiveBytes()

int ServerSerial::receiveBytes	(	unsigned char *	bytes,
		const int	size
	)

overridevirtual

Gets an array of bytes (unsigned char) with size <= 'size' parameter.

The array is NOT null terminated.

Parameters

bytes	a previously allocated buffer where the received data is stored.
size	the size of the 'bytes' parameter.

Returns: the number of received bytes. The function returns 0 if no bytes are received.

Implements yarp::dev::ISerialDevice.

Definition at line 95 of file ServerSerial.cpp.

◆ receiveChar()

int ServerSerial::receiveChar ( char & chr )

overridevirtual

Gets one single char from the receive queue.

Parameters

chr	the received char.

Returns: 0 if no chars are received; 1 if one char is received.

Implements yarp::dev::ISerialDevice.

Definition at line 59 of file ServerSerial.cpp.

◆ receiveLine()

int ServerSerial::receiveLine	(	char *	line,
		const int	MaxLineLength
	)

overridevirtual

Gets one line (a sequence of chars with a ending '\n' or '\r') from the receive queue.

The ending '\n''\r' chars are not removed in the returned line.

Parameters

line	a previously allocated buffer where the received line is stored.
MaxLineLength	the size of the 'line' parameter.

Returns: the number of received characters (including the '
''\r' chars, plus the buffer terminator '\0'). The function returns 0 if no chars are received.

Implements yarp::dev::ISerialDevice.

Definition at line 86 of file ServerSerial.cpp.

◆ run()

void ServerSerial::run ( )

overridevirtual

The thread main loop deals with writing on ports here.

Implements yarp::os::Thread.

Definition at line 173 of file ServerSerial.cpp.

◆ send() [1/2]

bool ServerSerial::send	(	char *	msg,
		size_t	size
	)

overridevirtual

Implements yarp::dev::ISerialDevice.

Definition at line 37 of file ServerSerial.cpp.

◆ send() [2/2]

bool ServerSerial::send ( const Bottle & msg )

overridevirtual

Sends a string of chars to the serial communications channel.

Parameters

msg	the string to send

Returns: true on success

Implements yarp::dev::ISerialDevice.

Definition at line 25 of file ServerSerial.cpp.

◆ setDTR()

bool ServerSerial::setDTR ( bool enable )

overridevirtual

Enable/Disable DTR protocol.

Parameters

enable Enable/Disable DTR protocol

Returns: true on success

Implements yarp::dev::ISerialDevice.

Definition at line 77 of file ServerSerial.cpp.

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

src/devices/ServerSerial/ServerSerial.h
src/devices/ServerSerial/ServerSerial.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ServerSerial() [1/3]

◆ ServerSerial() [2/3]

◆ ServerSerial() [3/3]

◆ ~ServerSerial()

Member Function Documentation

◆ close()

◆ flush()

◆ open() [1/2]

◆ open() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ receive()

◆ receiveBytes()

◆ receiveChar()

◆ receiveLine()

◆ run()

◆ send() [1/2]

◆ send() [2/2]

◆ setDTR()