mt4cpp: mt4cpp::BasicSerialPort< clock_type > Class Template Reference

mt4cpp

mt4cpp
BasicSerialPort

the template for object represents serial port with timeout More...

#include <SerialPort.hpp>

Inheritance diagram for mt4cpp::BasicSerialPort< clock_type >:

Inheritance graph

Collaboration diagram for mt4cpp::BasicSerialPort< clock_type >:

Collaboration graph

Public Types
typedef std::vector< char >	Buffer

typedef clock_type	Clock

typedef Clock::duration	Timeout

typedef boost::function1< bool, const Buffer & >	ReadPredicate

Public Member Functions
	BasicSerialPort (const std::string &port_name, const Timeout timeout, boost::asio::serial_port_base::baud_rate baud_rate=boost::asio::serial_port_base::baud_rate(9600), boost::asio::serial_port_base::flow_control flow_control=boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none), boost::asio::serial_port_base::parity parity=boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none), boost::asio::serial_port_base::stop_bits stop_bits=boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one), boost::asio::serial_port_base::character_size character_size=boost::asio::serial_port_base::character_size(8))

	~BasicSerialPort ()

const Buffer &	read_if (ReadPredicate p)

const Buffer &	read_n (int n)

Buffer::size_type	write (const Buffer &buf)

Detailed Description

template<typename clock_type>
class mt4cpp::BasicSerialPort< clock_type >

the template for object represents serial port with timeout

Parameters

clock_type the type of the clock, e.g. boost::chrono::steady_clock

Constructor & Destructor Documentation

template<typename clock_type >

mt4cpp::BasicSerialPort< clock_type >::BasicSerialPort	(	const std::string &	port_name,
		const Timeout	timeout,
		boost::asio::serial_port_base::baud_rate	baud_rate = `boost::asio::serial_port_base::baud_rate(9600)`,
		boost::asio::serial_port_base::flow_control	flow_control = `boost::asio::serial_port_base::flow_control(boost::asio::serial_port_base::flow_control::none)`,
		boost::asio::serial_port_base::parity	parity = `boost::asio::serial_port_base::parity(boost::asio::serial_port_base::parity::none)`,
		boost::asio::serial_port_base::stop_bits	stop_bits = `boost::asio::serial_port_base::stop_bits(boost::asio::serial_port_base::stop_bits::one)`,
		boost::asio::serial_port_base::character_size	character_size = `boost::asio::serial_port_base::character_size(8)`
	)

inline

c-tor

template<typename clock_type >

mt4cpp::BasicSerialPort< clock_type >::~BasicSerialPort ( )

inline

d-tor

Member Function Documentation

template<typename clock_type >

const Buffer& mt4cpp::BasicSerialPort< clock_type >::read_if ( ReadPredicate p )

inline

read from port when predicate return true_type

Referenced by mt4cpp::BasicSerialPort< clock_type >::read_n().

template<typename clock_type >

const Buffer& mt4cpp::BasicSerialPort< clock_type >::read_n ( int n )

inline

read n bytes

References mt4cpp::BasicSerialPort< clock_type >::read_if().

template<typename clock_type >

Buffer::size_type mt4cpp::BasicSerialPort< clock_type >::write ( const Buffer & buf )

inline

write into port. Return number bytes written.

< write buffer to port. Return number of written bytes

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

/home/robert/projects/sf/mt4cpp/mt4cpp/SerialPort.hpp