ERC CISST - cisst software

---

osaSerialPort Class Reference
[OS Abstraction]

#include <osaSerialPort.h>

Inheritance diagram for osaSerialPort:

[legend]Collaboration diagram for osaSerialPort:

[legend]List of all members.

---

Detailed Description

Serial port.

Create a serial port for sending and receiving data.

Definition at line 51 of file osaSerialPort.h.

Public Types

• enum BaudRateType
• enum CharacterSizeType
• enum ParityCheckingType
• enum FlowControlType
• enum StopBitsType

Public Member Functions

• osaSerialPort (void)
• virtual ~osaSerialPort (void)
• void SetBaudRate (const BaudRateType &baudRate)
• void SetCharacterSize (const CharacterSizeType &characterSize)
• void SetParityChecking (const ParityCheckingType &parityChecking)
• void SetStopBits (const StopBitsType &stopBits)
• void SetFlowControl (const FlowControlType &flowControl)
• void SetPortName (const std::string &portName)
• std::string GetPortName (void) const
• std::string SetPortNumber (unsigned int portNumber)
• bool Open (bool blocking=false)
• bool Configure (void)
• bool Close (void)
• bool IsOpened (void) const
• int Write (const char *data, int nBytes)
• int Write (const unsigned char *data, int nBytes)
• int Write (const std::string &data)
• int Read (char *data, int nBytes)
• int Read (unsigned char *data, int nBytes)
• bool WriteBreak (double breakLengthInSeconds)
• bool Flush (void)

---

Member Enumeration Documentation

enum osaSerialPort::BaudRateType

Type used to define the baud rate.

See also:

SetBaudRate

Definition at line 63 of file osaSerialPort.h.

enum osaSerialPort::CharacterSizeType

Type used to define the character size.

See also:

SetCharacterSize

Definition at line 84 of file osaSerialPort.h.

enum osaSerialPort::ParityCheckingType

Type used to define the parity checking.

See also:

SetParityChecking

Definition at line 99 of file osaSerialPort.h.

enum osaSerialPort::FlowControlType

Type used to define the flow control.

See also:

SetFlowControl

Definition at line 111 of file osaSerialPort.h.

enum osaSerialPort::StopBitsType

Type used to define stop bits.

See also:

SetStopBits

Definition at line 117 of file osaSerialPort.h.

---

Constructor & Destructor Documentation

osaSerialPort::osaSerialPort

(

void

)

[inline]

Default constructor. Set parameters to default 8N1 (8 bits per character, no parity checking, 1 stop bit) and 9600 baud rate. This constructor doesn't start anything, use Open() to actually start the serial port connection.

Definition at line 125 of file osaSerialPort.h.

virtual osaSerialPort::~osaSerialPort

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

void osaSerialPort::SetBaudRate

(

const BaudRateType &

baudRate

)

[inline]

Set a different baud rate.

Definition at line 147 of file osaSerialPort.h.

References CMN_LOG_CLASS_INIT_VERBOSE.

void osaSerialPort::SetCharacterSize

(

const CharacterSizeType &

characterSize

)

[inline]

Set a different character size.

Definition at line 154 of file osaSerialPort.h.

References CMN_LOG_CLASS_INIT_VERBOSE.

void osaSerialPort::SetParityChecking

(

const ParityCheckingType &

parityChecking

)

[inline]

Set a different parity checking.

Definition at line 161 of file osaSerialPort.h.

References CMN_LOG_CLASS_INIT_VERBOSE.

void osaSerialPort::SetStopBits

(

const StopBitsType &

stopBits

)

[inline]

Set different stop bits.

Definition at line 168 of file osaSerialPort.h.

References CMN_LOG_CLASS_INIT_VERBOSE.

void osaSerialPort::SetFlowControl

(

const FlowControlType &

flowControl

)

[inline]

Set different flow control.

Definition at line 175 of file osaSerialPort.h.

References CMN_LOG_CLASS_INIT_VERBOSE.

void osaSerialPort::SetPortName

(

const std::string &

portName

)

[inline]

Set the port name. For a more portable code, use SetPortNumber.

Definition at line 182 of file osaSerialPort.h.

std::string osaSerialPort::GetPortName

(

void

)

const [inline]

Get the current port name.

Definition at line 187 of file osaSerialPort.h.

std::string osaSerialPort::SetPortNumber

(

unsigned int

portNumber

)

Set the serial port name based on a number, starting from 1.

bool osaSerialPort::Open

(

bool

blocking = false

)

Open the serial port. This method starts the serial port based on the parameters previously set (either the defaults of those defined by SetBaudRate, SetCharacterSize, SetParityChecking, SetHardwareFlowControl, ...).

bool osaSerialPort::IsOpened

(

void

)

const [inline]

Indicates if the port has been opened or closed correctly.

Definition at line 205 of file osaSerialPort.h.

int osaSerialPort::Write	(	const char *	data,
		int	nBytes
	)

Send raw data.

int osaSerialPort::Read	(	char *	data,
		int	nBytes
	)

Receive raw data.

bool osaSerialPort::WriteBreak

(

double

breakLengthInSeconds

)

Sends a serial break for a given duration in seconds.

On Linux, if the break duration is set to 0, the actual duration will be at least 0.25 seconds and at most 0.5 seconds.

On Mac OS, the implementation doesn't use the breakLengthInSeconds. To provide a similar runtime, osaSleep is used internaly. As the default duration on MacOS it 0.4 seconds, the actual sleep time is breakLengthInSeconds - 0.4.

On Windows, this method is implemented using SetCommBreak, osaSleep and ClearCommBreak.

bool osaSerialPort::Flush

(

void

)

Flush.

---

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

• osaSerialPort.h

---