sg_serial.hxx

Go to the documentation of this file.

// Written by Curtis Olson, started November 1999.
//
// Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// $Id: sg__serial_8hxx_source.html,v 1.3 2010/02/23 22:10:16 curt Exp $


#ifndef _SG_SERIAL_HXX
#define _SG_SERIAL_HXX


#ifndef __cplusplus
# error This library requires C++
#endif

#include <simgear/compiler.h>

#include <string>

#include <simgear/serial/serial.hxx>

#include "iochannel.hxx"

using std::string;

class SGSerial : public SGIOChannel {

    string device;
    string baud;
    SGSerialPort port;

    char save_buf[ 2 * SG_IO_MAX_MSG_SIZE ];
    int save_len;

public:

    SGSerial( const string& device_name, const string& baud_rate );

    ~SGSerial();

    // open the serial port based on specified direction
    bool open( const SGProtocolDir d );

    // read a block of data of specified size
    int read( char *buf, int length );

    // read a line of data, length is max size of input buffer
    int readline( char *buf, int length );

    // write data to port
    int write( const char *buf, const int length );

    // write null terminated string to port
    int writestring( const char *str );

    // close port
    bool close();

    inline string get_device() const { return device; }

    inline string get_baud() const { return baud; }
};


#endif // _SG_SERIAL_HXX

---