Class SerialStream

Defined in File serial_stream.hpp

Inheritance Relationships

Base Type

public ecl::TextStream< Serial > (Template Class TextStream)

Class Documentation

class SerialStream : public ecl::TextStream<Serial>

Convenience class for Serial TextStream definitions.

This class provides a convenient handle for both writing and opening TextStream<Serial> objects. It has no further functionality.

See also

TextStream.

Public Functions

inline SerialStream()

Default constructor, underlying device must be manually opened.

This must open the device manually via device().open() as you would do if using a TextStream.

inline SerialStream(const std::string &port_name, const BaudRate &baud_rate = BaudRate_115200, const DataBits &data_bits = DataBits_8, const StopBits &stop_bits = StopBits_1, const Parity &parity = NoParity)

Convenience constructor for serial text streams.

This constructor enables RAII style construction of the underlying device (this makes it distinct from a generic TextStream<Serial> object).

Parameters:

port_name – : the device name.
baud_rate – : baud rate.
data_bits – : the number of bits in a single message byte.
stop_bits – : the number of bits after the data used for error checking.
parity – : the parity used for checksums.

Throws:

StandardException – : throws if the connection failed to open.

inline virtual ~SerialStream()