zep::serial Namespace Reference

Namespace for serial communication tunneling related elements. More...

Classes
class	FactoryInterface
	factory function interface for serial communication tunneling related streams More...
class	PortConfig
	Class to store settings for general serial ports. More...
class	TunnelCallbackInterface
	シリアル通信トンネリング機能のコールバックインターフェース More...
class	TunnelConfig
	Class to store tunneling configuration. More...
class	TunnelInterface
	シリアル通信トンネリング機能のインターフェース More...

Functions
class zep::serial::PortConfig	PortConfig () noexcept
	Default construction of PortConfig object.
	PortConfig (int baud_rate, int data_bits, StopBits stop_bits, Parity parity) noexcept PortConfig(int baud_rate
	Construct a PortConfig object with initial values.
int StopBits Parity parity	data_bits_ (data_bits)
int StopBits Parity parity	stop_bits_ (stop_bits) stop_bits_(stop_bits)
int StopBits Parity parity	parity_ (parity) parity_(parity)
int	GetBaudRate () const noexcept
	Get baud rate (in bps).
void	SetBaudRate (int new_value) noexcept
	Set baud rate (in bps).
int	GetDataBits () const noexcept
	Get the number of bits of data (character).
void	SetDataBits (int new_value) noexcept
	Set the number of data (character) bits.
StopBits	GetStopBits () const noexcept
	Get the number of stop bits.
void	SetStopBits (StopBits new_value) noexcept
	Get the number of stop bits.
Parity	GetParity () const noexcept
	Get parity.
void	SetParity (Parity new_value) noexcept
	Set parity.
class zep::serial::TunnelConfig	TunnelConfig () noexcept
	Default construction of the SerialTunnelConfig object.
	TunnelConfig (int baud_rate, int data_bits, PortConfig::StopBits stop_bits PortConfig::Parity parity, PacketizeMode packetize_mode) noexcept
	Construct a SerialPortConfig object with initial values.
const PortConfig &	GetPortConfig () const noexcept
	Get port configuration.
void	SetPortConfig (const PortConfig &new_value) noexcept
	Get the port configuration.
PacketizeMode	GetPacketizeMode () const noexcept
	Get the type of packetization.
void	SetPacketizeMode (PacketizeMode new_value) noexcept
	Set the packetization type.

Variables
int	data_bits
int StopBits	stop_bits

Detailed Description

Namespace for serial communication tunneling related elements.

シリアル通信トンネリング関係の要素をまとめた名前空間

Function Documentation

PortConfig()

zep::serial::PortConfig ( int  baud_rate, int  data_bits, StopBits  stop_bits, Parity  parity  )

noexcept

Construct a PortConfig object with initial values.

Parameters

baud_rate
baud_rate	baud rate [bps].
data_bits	Number of data (character) bits [bit].
stop_bits	Number of stop bits
parity	parity

SetBaudRate()

void zep::serial::SetBaudRate ( int  new_value )

noexcept

Set baud rate (in bps).

Parameters

new_value

Baud rate [bps].

SetDataBits()

void zep::serial::SetDataBits ( int  new_value )

noexcept

Set the number of data (character) bits.

Parameters

new_value

Number of data (character) bits [bit].

SetPacketizeMode()

void zep::serial::SetPacketizeMode ( PacketizeMode  new_value )

noexcept

Set the packetization type.

Parameters

new_value

Packetize type

SetParity()

void zep::serial::SetParity ( Parity  new_value )

noexcept

Set parity.

Parameters

new_value

parity

SetPortConfig()

void zep::serial::SetPortConfig ( const PortConfig &  new_value )

noexcept

Get the port configuration.

Parameters

new_value

Port configuration.

SetStopBits()

void zep::serial::SetStopBits ( StopBits  new_value )

noexcept

Get the number of stop bits.

Parameters

new_value

Number of stop bits

TunnelConfig() [1/2]

class zep::serial::TunnelConfig zep::serial::TunnelConfig ( )

noexcept

Default construction of the SerialTunnelConfig object.

TunnelConfig() [2/2]

zep::serial::TunnelConfig ( int  baud_rate, int  data_bits, PortConfig::StopBits stop_bits PortConfig::Parity  parity, PacketizeMode  packetize_mode  )

noexcept

Construct a SerialPortConfig object with initial values.

Parameters

baud_rate	baud rate [bps] *
data_bits
data_bits	Number of data (character) bits [bit].
stop_bits	Number of stop bits
parity	parity