Public Types | Public Member Functions | Private Attributes
icl_comm::serial::SerialFlags Class Reference

Short description of tSerialFlags. More...

#include <SerialFlags.h>

List of all members.

Public Types

enum  BaudRate {
  eBR_0 = 0, eBR_50 = 50, eBR_75 = 75, eBR_110 = 110,
  eBR_134 = 134, eBR_150 = 150, eBR_200 = 200, eBR_300 = 300,
  eBR_600 = 600, eBR_1200 = 1200, eBR_1800 = 1800, eBR_2400 = 2400,
  eBR_4800 = 4800, eBR_9600 = 9600, eBR_19200 = 19200, eBR_38400 = 38400,
  eBR_57600 = 57600, eBR_115200 = 115200, eBR_230400 = 230400, eBR_500000 = 500000,
  eBR_921600 = 921600
}
enum  DataBits { eDB_5 = 5, eDB_6 = 6, eDB_7 = 7, eDB_8 = 8 }
enum  FlowControl { eFC_FLOW, eFC_HAND_SHAKE }
enum  ModemControlFlags { eMCF_NULL = 0x000, eMCF_DTR = 0x002, eMCF_RTS = 0x004, eMCF_UNDEFINED = 0x800 }
enum  Parity {
  eP_NONE, eP_EVEN, eP_ODD, eP_MARK,
  eP_SPACE
}
enum  StopBits { eSB_1, eSB_1P5, eSB_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 (DataBits data_bits, Parity parity=eP_NONE, bool use_modem_control=false, bool enable_receiver=false, bool enable_stop_on_receive=false, ModemControlFlags modem_control_flags=eMCF_UNDEFINED)
 SerialFlags (BaudRate baud_rate, DataBits data_bits, Parity parity=eP_NONE, bool use_modem_control=false, bool enable_receiver=false, bool enable_stop_on_receive=false, ModemControlFlags modem_control_flags=eMCF_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=eMCF_UNDEFINED)
 SerialFlags (const SerialFlags &flags)
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 44 of file SerialFlags.h.


Member Enumeration Documentation

Enumerator:
eBR_0 
eBR_50 
eBR_75 
eBR_110 
eBR_134 
eBR_150 
eBR_200 
eBR_300 
eBR_600 
eBR_1200 
eBR_1800 
eBR_2400 
eBR_4800 
eBR_9600 
eBR_19200 
eBR_38400 
eBR_57600 
eBR_115200 
eBR_230400 
eBR_500000 
eBR_921600 

Definition at line 72 of file SerialFlags.h.

Enumerator:
eDB_5 
eDB_6 
eDB_7 
eDB_8 

Definition at line 48 of file SerialFlags.h.

Enumerator:
eFC_FLOW 
eFC_HAND_SHAKE 

Definition at line 97 of file SerialFlags.h.

Enumerator:
eMCF_NULL 
eMCF_DTR 
eMCF_RTS 
eMCF_UNDEFINED 

Definition at line 103 of file SerialFlags.h.

Enumerator:
eP_NONE 
eP_EVEN 
eP_ODD 
eP_MARK 
eP_SPACE 

Definition at line 63 of file SerialFlags.h.

Enumerator:
eSB_1 
eSB_1P5 
eSB_2 

Definition at line 56 of file SerialFlags.h.


Constructor & Destructor Documentation

Definition at line 111 of file SerialFlags.h.

icl_comm::serial::SerialFlags::SerialFlags ( DataBits  data_bits,
Parity  parity = eP_NONE,
bool  use_modem_control = false,
bool  enable_receiver = false,
bool  enable_stop_on_receive = false,
ModemControlFlags  modem_control_flags = eMCF_UNDEFINED 
) [inline]

Definition at line 123 of file SerialFlags.h.

icl_comm::serial::SerialFlags::SerialFlags ( BaudRate  baud_rate,
DataBits  data_bits,
Parity  parity = eP_NONE,
bool  use_modem_control = false,
bool  enable_receiver = false,
bool  enable_stop_on_receive = false,
ModemControlFlags  modem_control_flags = eMCF_UNDEFINED 
) [inline]

Definition at line 136 of file SerialFlags.h.

icl_comm::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 = eMCF_UNDEFINED 
) [inline]

Definition at line 149 of file SerialFlags.h.

Definition at line 163 of file SerialFlags.h.


Member Function Documentation

Definition at line 178 of file SerialFlags.h.

Definition at line 177 of file SerialFlags.h.

Definition at line 175 of file SerialFlags.h.

Definition at line 176 of file SerialFlags.h.

Definition at line 179 of file SerialFlags.h.

Definition at line 186 of file SerialFlags.h.

Definition at line 180 of file SerialFlags.h.

Definition at line 181 of file SerialFlags.h.

Definition at line 184 of file SerialFlags.h.

Definition at line 182 of file SerialFlags.h.


Member Data Documentation

Definition at line 200 of file SerialFlags.h.

Definition at line 197 of file SerialFlags.h.

Definition at line 204 of file SerialFlags.h.

Definition at line 205 of file SerialFlags.h.

Definition at line 201 of file SerialFlags.h.

Definition at line 203 of file SerialFlags.h.

Definition at line 199 of file SerialFlags.h.

Definition at line 198 of file SerialFlags.h.

Definition at line 202 of file SerialFlags.h.


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


fzi_icl_comm
Author(s):
autogenerated on Thu Jun 6 2019 21:31:31