Public Types | Public Member Functions | Public Attributes | List of all members
swri_serial_util::SerialConfig Struct Reference

#include <serial_port.h>

Public Types

enum  Parity { NO_PARITY, EVEN_PARITY, ODD_PARITY }
 

Public Member Functions

 SerialConfig ()
 
 SerialConfig (int32_t baud, int32_t data_bits, int32_t stop_bits, Parity parity, bool flow_control, bool low_latency_mode, bool writable)
 

Public Attributes

int32_t baud
 
int32_t data_bits
 
bool flow_control
 
bool low_latency_mode
 
Parity parity
 
int32_t stop_bits
 
bool writable
 

Detailed Description

Structure defining serial port configuration parameters.

Definition at line 43 of file serial_port.h.

Member Enumeration Documentation

◆ Parity

Enumerator
NO_PARITY 
EVEN_PARITY 
ODD_PARITY 

Definition at line 45 of file serial_port.h.

Constructor & Destructor Documentation

◆ SerialConfig() [1/2]

swri_serial_util::SerialConfig::SerialConfig ( )

Default constructor.

baud = 115200 parity = NO_PARITY flow control = false data bits = 8 stop bits = 1 low latency mode = false

Definition at line 45 of file serial_port.cpp.

◆ SerialConfig() [2/2]

swri_serial_util::SerialConfig::SerialConfig ( int32_t  baud,
int32_t  data_bits,
int32_t  stop_bits,
Parity  parity,
bool  flow_control,
bool  low_latency_mode,
bool  writable 
)

Definition at line 56 of file serial_port.cpp.

Member Data Documentation

◆ baud

int32_t swri_serial_util::SerialConfig::baud

Definition at line 73 of file serial_port.h.

◆ data_bits

int32_t swri_serial_util::SerialConfig::data_bits

Definition at line 74 of file serial_port.h.

◆ flow_control

bool swri_serial_util::SerialConfig::flow_control

Definition at line 77 of file serial_port.h.

◆ low_latency_mode

bool swri_serial_util::SerialConfig::low_latency_mode

Definition at line 78 of file serial_port.h.

◆ parity

Parity swri_serial_util::SerialConfig::parity

Definition at line 76 of file serial_port.h.

◆ stop_bits

int32_t swri_serial_util::SerialConfig::stop_bits

Definition at line 75 of file serial_port.h.

◆ writable

bool swri_serial_util::SerialConfig::writable

Definition at line 79 of file serial_port.h.


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


swri_serial_util
Author(s): Marc Alban
autogenerated on Sat Jan 21 2023 03:13:23