SerialStreamBuf.h

Go to the documentation of this file.

/*
 * Time-stamp: <2008-11-15 13:06:59 pagey>
 *
 * $Id: SerialStreamBuf.h,v 1.9 2005-10-17 00:19:12 crayzeewulf Exp $
 *
 *
 */
#ifndef _SerialStreamBuf_h_
#define _SerialStreamBuf_h_

#include <SerialPort.h>
#include <boost/scoped_ptr.hpp>
#include <streambuf>
#include <string>

extern "C++" 
{
    namespace LibSerial 
    {
        class SerialStreamBuf : public std::streambuf 
        {
        public:
            /* 
             * -----------------------------------------------------------------
             * Enumerations.
             * -----------------------------------------------------------------
             */
            enum BaudRateEnum 
            {
                BAUD_50    = SerialPort::BAUD_50,
                BAUD_75    = SerialPort::BAUD_75,
                BAUD_110   = SerialPort::BAUD_110,
                BAUD_134   = SerialPort::BAUD_134,
                BAUD_150   = SerialPort::BAUD_150,
                BAUD_200   = SerialPort::BAUD_200,
                BAUD_300   = SerialPort::BAUD_300,
                BAUD_600   = SerialPort::BAUD_600,
                BAUD_1200  = SerialPort::BAUD_1200,
                BAUD_1800  = SerialPort::BAUD_1800,
                BAUD_2400  = SerialPort::BAUD_2400,
                BAUD_4800  = SerialPort::BAUD_4800,
                BAUD_9600  = SerialPort::BAUD_9600,
                BAUD_19200 = SerialPort::BAUD_19200,
                BAUD_38400 = SerialPort::BAUD_38400,
                BAUD_57600 = SerialPort::BAUD_57600,
                BAUD_115200 = SerialPort::BAUD_115200,
                BAUD_230400 = SerialPort::BAUD_230400,
#ifdef __linux__
                BAUD_460800 = SerialPort::BAUD_460800,
                BAUD_500000 = SerialPort::BAUD_500000, 
                BAUD_576000 = SerialPort::BAUD_576000, 
                BAUD_921600 = SerialPort::BAUD_921600, 
                BAUD_1000000 = SerialPort::BAUD_1000000, 
                BAUD_1152000 = SerialPort::BAUD_1152000, 
                BAUD_1500000 = SerialPort::BAUD_1500000, 
                BAUD_2000000 = SerialPort::BAUD_2000000, 
                BAUD_2500000 = SerialPort::BAUD_2500000, 
                BAUD_3000000 = SerialPort::BAUD_3000000, 
                BAUD_3500000 = SerialPort::BAUD_3500000, 
                BAUD_4000000 = SerialPort::BAUD_4000000, 
#endif
                BAUD_DEFAULT = SerialPort::BAUD_DEFAULT,
                BAUD_INVALID = -1
            } ;

            enum CharSizeEnum 
            {
                CHAR_SIZE_5 = SerialPort::CHAR_SIZE_5,
                CHAR_SIZE_6 = SerialPort::CHAR_SIZE_6,
                CHAR_SIZE_7 = SerialPort::CHAR_SIZE_7,
                CHAR_SIZE_8 = SerialPort::CHAR_SIZE_8,
                CHAR_SIZE_DEFAULT = SerialPort::CHAR_SIZE_DEFAULT,
                CHAR_SIZE_INVALID
            } ;

            enum ParityEnum 
            {
                PARITY_EVEN = SerialPort::PARITY_EVEN,
                PARITY_ODD  = SerialPort::PARITY_ODD,
                PARITY_NONE = SerialPort::PARITY_NONE,
                PARITY_DEFAULT = SerialPort::PARITY_DEFAULT,
                PARITY_INVALID   
            } ;

            enum FlowControlEnum 
            {
                FLOW_CONTROL_HARD    = SerialPort::FLOW_CONTROL_HARD,
                FLOW_CONTROL_SOFT    = SerialPort::FLOW_CONTROL_SOFT,
                FLOW_CONTROL_NONE    = SerialPort::FLOW_CONTROL_NONE,
                FLOW_CONTROL_DEFAULT = SerialPort::FLOW_CONTROL_DEFAULT,
                FLOW_CONTROL_INVALID 
            } ;

            /* ------------------------------------------------------------
             * Public Static Members
             * ------------------------------------------------------------
             */
            static const BaudRateEnum DEFAULT_BAUD ;

            static const CharSizeEnum DEFAULT_CHAR_SIZE ;

            static const short DEFAULT_NO_OF_STOP_BITS ;

            static const ParityEnum DEFAULT_PARITY ;
      
            static const FlowControlEnum DEFAULT_FLOW_CONTROL ;

            static const short DEFAULT_VMIN ;

            static const short DEFAULT_VTIME ;

            /* -----------------------------------------------------------------
             * Constructors and Destructor
             * -----------------------------------------------------------------
             */
            SerialStreamBuf() ;

            ~SerialStreamBuf() ;

            /* -----------------------------------------------------------------
             * Other Public Methods
             * -----------------------------------------------------------------
             */
            bool is_open() const ;

            SerialStreamBuf* open( const std::string filename,
                                   std::ios_base::openmode mode =
                                   std::ios_base::in | std::ios_base::out ) ;

            SerialStreamBuf* close() ;

            int SetParametersToDefault() ;

            const BaudRateEnum SetBaudRate(const BaudRateEnum baudRate ) ;

            const BaudRateEnum BaudRate() const ;

            const CharSizeEnum SetCharSize(const CharSizeEnum charSize) ;

            const CharSizeEnum CharSize() const ;

            short SetNumOfStopBits(short numOfStopBits) ;

            short NumOfStopBits() const ; 

            const ParityEnum SetParity(const ParityEnum parityType) ;

            const ParityEnum Parity() const ;

            const FlowControlEnum SetFlowControl(const FlowControlEnum flowControlType) ;

            const FlowControlEnum FlowControl() const ;

            const short SetVMin( short vtime ) ;

            const short VMin() const;

            const short SetVTime( short vtime ) ;

            const short VTime() const;

            /* -----------------------------------------------------------------
             * Operators
             * -----------------------------------------------------------------
             */

            /* ------------------------------------------------------------
             * Friends
             * ------------------------------------------------------------
             */
        protected:
            /* ------------------------------------------------------------
             * Protected Data Members
             * ------------------------------------------------------------
             */
            static const char CTRL_Q = 0x11 ;
      
            static const char CTRL_S = 0x13 ;
            /* ------------------------------------------------------------
             * Protected Methods
             * ------------------------------------------------------------
             */
            virtual std::streambuf* setbuf( char_type*, 
                                            std::streamsize ) ;

            virtual std::streamsize xsgetn( char_type*      s, 
                                            std::streamsize n ) ;

            virtual std::streamsize showmanyc();

            virtual int_type underflow() ;

            virtual int_type   uflow() ;

            virtual int_type pbackfail(int_type c = traits_type::eof()) ;

            virtual std::streamsize xsputn( const char_type* s, 
                                            std::streamsize  n ) ;

            virtual int_type overflow(int_type c) ;

        private:
            /* ------------------------------------------------------------
             * Private Data Members
             * ------------------------------------------------------------
             */
            //
            // The copy constructor and the assignment operator are
            // declared private but never defined. This allows the
            // compiler to catch attempts to copy instances of this
            // class.
            //
            SerialStreamBuf( const SerialStreamBuf& ) ;
            SerialStreamBuf& operator=( const SerialStreamBuf& ) ;

            class Implementation ;
            boost::scoped_ptr<Implementation> mImpl ;
        } ; // class SerialStreamBuf
    } // namespace LibSerial
} // extern "C++"
#endif // #ifndef _SerialStreamBuf_h_