Conexus::SerialInterface Class Reference

#include <serial_interface.h>

Inheritance diagram for Conexus::SerialInterface:

[legend]

List of all members.

Public Types
typedef ConexusPointer < SerialInterface >	pointer
Public Member Functions
	SerialInterface ()
virtual	~SerialInterface ()
virtual void	open (const std::string &device, ReadWrite rwmode=READ_WRITE_UNCHANGED)=0
	Opens the named serial port device in the specified mode.
virtual void	open ()=0
	Will attempt to open the serial port if a device has been specified.
virtual uint32_t	rw_mode ()=0
virtual std::string	device ()=0
	Will return the string representing the device associated with this serial object.
virtual void	set_device (const std::string &device, ReadWrite rwmode=READ_WRITE_UNCHANGED)=0
	Sets the string representing the device associated with this serial object.
virtual sigc::signal< void > &	signal_device_changed ()=0

---

Detailed Description

Author:

Rick L Vinyard Jr

---

Member Typedef Documentation

typedef ConexusPointer<SerialInterface> Conexus::SerialInterface::pointer

Reimplemented in Conexus::Serial, Conexus::TTY, and Conexus::TTYInterface.

---

Constructor & Destructor Documentation

Conexus::SerialInterface::SerialInterface

(

)

[inline]

virtual Conexus::SerialInterface::~SerialInterface

(

)

[inline, virtual]

---

Member Function Documentation

virtual std::string Conexus::SerialInterface::device

(

)

[pure virtual]

Will return the string representing the device associated with this serial object.

Implemented in Conexus::Serial.

virtual void Conexus::SerialInterface::open

(

)

[pure virtual]

Will attempt to open the serial port if a device has been specified.

Otherwise an exception will be thrown.

Implemented in Conexus::Serial, Conexus::TTY, and Conexus::TTYInterface.

virtual void Conexus::SerialInterface::open	(	const std::string &	device,
		ReadWrite	rwmode = READ_WRITE_UNCHANGED
	)			[pure virtual]

Opens the named serial port device in the specified mode.

Implemented in Conexus::Serial, Conexus::TTY, and Conexus::TTYInterface.

virtual uint32_t Conexus::SerialInterface::rw_mode

(

)

[pure virtual]

Implemented in Conexus::Serial.

virtual void Conexus::SerialInterface::set_device	(	const std::string &	device,
		ReadWrite	rwmode = READ_WRITE_UNCHANGED
	)			[pure virtual]

Sets the string representing the device associated with this serial object.

If the serial device is currently open and d is not equal to the current device, the current device will be closed.

Also, if auto_open is set, the new device will be immediately opened.

Additionally, this method checks whether the parameter d is the same as the current device, and parameter mode is the same as the current mode. If both are equal, the device will not be closed and reopened unless force=true.

Implemented in Conexus::Serial.

virtual sigc::signal<void>& Conexus::SerialInterface::signal_device_changed

(

)

[pure virtual]

Implemented in Conexus::Serial.

---

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

• serial_interface.h