driver_svh::serial::SerialFlags Class Reference

Short description of tSerialFlags. More...

#include <SerialFlags.h>

Public Types
enum	BaudRate {   BR_0 = 0, BR_50 = 50, BR_75 = 75, BR_110 = 110,   BR_134 = 134, BR_150 = 150, BR_200 = 200, BR_300 = 300,   BR_600 = 600, BR_1200 = 1200, BR_1800 = 1800, BR_2400 = 2400,   BR_4800 = 4800, BR_9600 = 9600, BR_19200 = 19200, BR_38400 = 38400,   BR_57600 = 57600, BR_115200 = 115200, BR_230400 = 230400, BR_500000 = 500000,   BR_921600 = 921600 }
enum	DataBits { DB_5 = 5, DB_6 = 6, DB_7 = 7, DB_8 = 8 }
enum	FlowControl { FC_FLOW, FC_HAND_SHAKE }
enum	ModemControlFlags { MCF_NULL = 0x000, MCF_DTR = 0x002, MCF_RTS = 0x004, MCF_UNDEFINED = 0x800 }
enum	Parity {   P_NONE, P_EVEN, P_ODD, P_MARK,   P_SPACE }
enum	StopBits { SB_1, SB_1_P5, SB_2 }

Public Member Functions
bool	enableReceiver () const
bool	enableStopOnReceive () const
BaudRate	getBaudRate () const
DataBits	getDataBits () const
FlowControl	getFlowControl () const
ModemControlFlags	getModemControlFlags () const
Parity	getParity () const
StopBits	getStopBits () const
	SerialFlags ()
	SerialFlags (BaudRate baud_rate, DataBits data_bits, Parity parity=P_NONE, bool use_modem_control=false, bool enable_receiver=false, bool enable_stop_on_receive=false, ModemControlFlags modem_control_flags=MCF_UNDEFINED)
	SerialFlags (BaudRate baud_rate, Parity parity, DataBits data_bits, StopBits stop_bits, bool use_modem_control=false, bool enable_receiver=false, bool enable_stop_on_receive=false, ModemControlFlags modem_control_flags=MCF_UNDEFINED)
	SerialFlags (const SerialFlags &flags)
	SerialFlags (DataBits data_bits, Parity parity=P_NONE, bool use_modem_control=false, bool enable_receiver=false, bool enable_stop_on_receive=false, ModemControlFlags modem_control_flags=MCF_UNDEFINED)
void	setBaudRate (BaudRate baud_rate)
bool	useModemControl () const

Private Attributes
BaudRate	m_baud_rate
DataBits	m_data_bits
bool	m_enable_receiver
bool	m_enable_stop_on_receive
FlowControl	m_flow_control
ModemControlFlags	m_modem_control_flags
Parity	m_parity
StopBits	m_stop_bits
bool	m_use_modem_control

Detailed Description

Short description of tSerialFlags.

A more detailed description of tSerialFlags, which Klaus Uhl hasn't done till now!

Definition at line 52 of file SerialFlags.h.

Member Enumeration Documentation

BaudRate

enum driver_svh::serial::SerialFlags::BaudRate

Enumerator
BR_0
BR_50
BR_75
BR_110
BR_134
BR_150
BR_200
BR_300
BR_600
BR_1200
BR_1800
BR_2400
BR_4800
BR_9600
BR_19200
BR_38400
BR_57600
BR_115200
BR_230400
BR_500000
BR_921600

Definition at line 79 of file SerialFlags.h.

DataBits

enum driver_svh::serial::SerialFlags::DataBits

Enumerator
DB_5
DB_6
DB_7
DB_8

Definition at line 55 of file SerialFlags.h.

FlowControl

enum driver_svh::serial::SerialFlags::FlowControl

Enumerator
FC_FLOW
FC_HAND_SHAKE

Definition at line 104 of file SerialFlags.h.

ModemControlFlags

enum driver_svh::serial::SerialFlags::ModemControlFlags

Enumerator
MCF_NULL
MCF_DTR
MCF_RTS
MCF_UNDEFINED

Definition at line 110 of file SerialFlags.h.

Parity

enum driver_svh::serial::SerialFlags::Parity

Enumerator
P_NONE
P_EVEN
P_ODD
P_MARK
P_SPACE

Definition at line 70 of file SerialFlags.h.

StopBits

enum driver_svh::serial::SerialFlags::StopBits

Enumerator
SB_1
SB_1_P5
SB_2

Definition at line 63 of file SerialFlags.h.

Constructor & Destructor Documentation

SerialFlags() [1/5]

driver_svh::serial::SerialFlags::SerialFlags ( )

inline

Definition at line 118 of file SerialFlags.h.

SerialFlags() [2/5]

driver_svh::serial::SerialFlags::SerialFlags ( DataBits  data_bits, Parity  parity = P_NONE, bool  use_modem_control = false, bool  enable_receiver = false, bool  enable_stop_on_receive = false, ModemControlFlags  modem_control_flags = MCF_UNDEFINED  )

inline

Definition at line 131 of file SerialFlags.h.

SerialFlags() [3/5]

driver_svh::serial::SerialFlags::SerialFlags ( BaudRate  baud_rate, DataBits  data_bits, Parity  parity = P_NONE, bool  use_modem_control = false, bool  enable_receiver = false, bool  enable_stop_on_receive = false, ModemControlFlags  modem_control_flags = MCF_UNDEFINED  )

inline

Definition at line 149 of file SerialFlags.h.

SerialFlags() [4/5]

driver_svh::serial::SerialFlags::SerialFlags ( BaudRate  baud_rate, Parity  parity, DataBits  data_bits, StopBits  stop_bits, bool  use_modem_control = false, bool  enable_receiver = false, bool  enable_stop_on_receive = false, ModemControlFlags  modem_control_flags = MCF_UNDEFINED  )

inline

Definition at line 168 of file SerialFlags.h.

SerialFlags() [5/5]

driver_svh::serial::SerialFlags::SerialFlags ( const SerialFlags &  flags )

inline

Definition at line 188 of file SerialFlags.h.

Member Function Documentation

enableReceiver()

bool driver_svh::serial::SerialFlags::enableReceiver ( ) const

inline

Definition at line 204 of file SerialFlags.h.

enableStopOnReceive()

bool driver_svh::serial::SerialFlags::enableStopOnReceive ( ) const

inline

Definition at line 203 of file SerialFlags.h.

getBaudRate()

BaudRate driver_svh::serial::SerialFlags::getBaudRate ( ) const

inline

Definition at line 201 of file SerialFlags.h.

getDataBits()

DataBits driver_svh::serial::SerialFlags::getDataBits ( ) const

inline

Definition at line 202 of file SerialFlags.h.

getFlowControl()

FlowControl driver_svh::serial::SerialFlags::getFlowControl ( ) const

inline

Definition at line 205 of file SerialFlags.h.

getModemControlFlags()

ModemControlFlags driver_svh::serial::SerialFlags::getModemControlFlags ( ) const

inline

Definition at line 212 of file SerialFlags.h.

getParity()

Parity driver_svh::serial::SerialFlags::getParity ( ) const

inline

Definition at line 206 of file SerialFlags.h.

getStopBits()

StopBits driver_svh::serial::SerialFlags::getStopBits ( ) const

inline

Definition at line 207 of file SerialFlags.h.

setBaudRate()

void driver_svh::serial::SerialFlags::setBaudRate ( BaudRate  baud_rate )

inline

Definition at line 210 of file SerialFlags.h.

useModemControl()

bool driver_svh::serial::SerialFlags::useModemControl ( ) const

inline

Definition at line 208 of file SerialFlags.h.

Member Data Documentation

m_baud_rate

BaudRate driver_svh::serial::SerialFlags::m_baud_rate

private

Definition at line 226 of file SerialFlags.h.

m_data_bits

DataBits driver_svh::serial::SerialFlags::m_data_bits

private

Definition at line 223 of file SerialFlags.h.

m_enable_receiver

bool driver_svh::serial::SerialFlags::m_enable_receiver

private

Definition at line 230 of file SerialFlags.h.

m_enable_stop_on_receive

bool driver_svh::serial::SerialFlags::m_enable_stop_on_receive

private

Definition at line 231 of file SerialFlags.h.

m_flow_control

FlowControl driver_svh::serial::SerialFlags::m_flow_control

private

Definition at line 227 of file SerialFlags.h.

m_modem_control_flags

ModemControlFlags driver_svh::serial::SerialFlags::m_modem_control_flags

private

Definition at line 229 of file SerialFlags.h.

m_parity

Parity driver_svh::serial::SerialFlags::m_parity

private

Definition at line 225 of file SerialFlags.h.

m_stop_bits

StopBits driver_svh::serial::SerialFlags::m_stop_bits

private

Definition at line 224 of file SerialFlags.h.

m_use_modem_control

bool driver_svh::serial::SerialFlags::m_use_modem_control

private

Definition at line 228 of file SerialFlags.h.

---

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

• SerialFlags.h