SGSerialPort Class Reference

A class to encapsulate low level serial port IO. More...

#include <serial.hxx>

List of all members.

Public Member Functions
	SGSerialPort ()
	Default constructor.
	SGSerialPort (const string &device, int baud)
	Constructor.
	~SGSerialPort ()
	Destructor.
bool	open_port (const string &device)
	Open a the serial port.
bool	close_port ()
	Close the serial port.
bool	set_baud (int baud)
	Set baud rate.
string	read_port ()
	Read from the serial port.
int	read_port (char *buf, int len)
	Read from the serial port.
int	write_port (const string &value)
	Write to the serial port.
int	write_port (const char *buf, int len)
	Write to the serial port.
bool	is_enabled ()
	Returns: true if device open

---

Detailed Description

A class to encapsulate low level serial port IO.

Definition at line 50 of file serial.hxx.

---

Constructor & Destructor Documentation

SGSerialPort::SGSerialPort	(	const string &	device,
		int	baud
	)

Constructor.

Parameters:

	device	device name
	baud	baud rate

Definition at line 52 of file serial.cxx.

References open_port(), and set_baud().

---

Member Function Documentation

bool SGSerialPort::open_port

(

const string &

device

)

Open a the serial port.

Parameters:

device

name of device

Returns:

success/failure

Definition at line 66 of file serial.cxx.

References SG_LOG.

Referenced by SGSerial::open(), and SGSerialPort().

bool SGSerialPort::close_port

(

)

Close the serial port.

Returns:

success/failure

Definition at line 154 of file serial.cxx.

Referenced by SGSerial::close().

bool SGSerialPort::set_baud

(

int

baud

)

Set baud rate.

Parameters:

baud

baud rate

Returns:

success/failure

Definition at line 167 of file serial.cxx.

References SG_LOG.

Referenced by SGSerial::open(), and SGSerialPort().

string SGSerialPort::read_port

(

)

Read from the serial port.

Returns:

line of data

Definition at line 276 of file serial.cxx.

References SG_LOG.

Referenced by SGSerial::read(), and SGSerial::readline().

int SGSerialPort::read_port	(	char *	buf,
		int	len
	)

Read from the serial port.

Parameters:

	buf	input buffer
	len	length of buffer (i.e. max number of bytes to read

Returns:

number of bytes read

Definition at line 332 of file serial.cxx.

References SG_LOG.

int SGSerialPort::write_port

(

const string &

value

)

Write to the serial port.

Parameters:

value

output string

Returns:

number of bytes written

Definition at line 389 of file serial.cxx.

References SG_LOG.

Referenced by SGSerial::write().

int SGSerialPort::write_port	(	const char *	buf,
		int	len
	)

Write to the serial port.

Parameters:

	buf	pointer to character buffer containing output data
	len	number of bytes to write from the buffer

Returns:

number of bytes written

Definition at line 464 of file serial.cxx.

References SG_LOG.

---

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

• serial.hxx
• serial.cxx

---