SerialStream.h

Go to the documentation of this file.

/*
 * Time-stamp: <2008-11-15 11:16:39 pagey>
 *
 * $Id: SerialStream.h,v 1.10 2005-10-01 21:24:21 crayzeewulf Exp $
 *
 *
 */
#ifndef _SerialStream_h_
#define _SerialStream_h_

#include <SerialStreamBuf.h>
#include <string>
#include <fstream>

extern "C++" 
{
    namespace LibSerial 
    {
        class SerialStream : public std::iostream 
        {
        public:
            /* ------------------------------------------------------------
             * Public Static Members
             * ------------------------------------------------------------ 
             */
            explicit SerialStream( const std::string fileName, 
                                   std::ios_base::openmode openMode =
                                   std::ios::in|std::ios::out) ;

            SerialStream( const std::string fileName,
                          const SerialStreamBuf::BaudRateEnum baudRate = SerialStreamBuf::DEFAULT_BAUD,
                          const SerialStreamBuf::CharSizeEnum charSize = SerialStreamBuf::DEFAULT_CHAR_SIZE,
                          const SerialStreamBuf::ParityEnum parityType = SerialStreamBuf::DEFAULT_PARITY,
                          const short numOfStopBits = SerialStreamBuf::DEFAULT_NO_OF_STOP_BITS,
                          const SerialStreamBuf::FlowControlEnum flowControlType = SerialStreamBuf::DEFAULT_FLOW_CONTROL ) ;

            explicit SerialStream() ;
      
            virtual ~SerialStream() ; 

            /* -----------------------------------------------------------------
             * Other Public Methods
             * -----------------------------------------------------------------
             */
            void Open( const std::string fileName, 
                       std::ios_base::openmode openMode = 
                       std::ios_base::in | std::ios_base::out) ;

            void Close() ;

            const bool IsOpen() const ;

            void SetBaudRate(SerialStreamBuf::BaudRateEnum baudRate ) ;

            const SerialStreamBuf::BaudRateEnum BaudRate() ;

            void SetCharSize(const SerialStreamBuf::CharSizeEnum charSize ) ;

            const SerialStreamBuf::CharSizeEnum CharSize() ;

            void SetNumOfStopBits(short numOfStopBits) ;

            const short NumOfStopBits() ; 

            void SetParity(const SerialStreamBuf::ParityEnum parityType) ;

            const SerialStreamBuf::ParityEnum Parity() ;

            void 
            SetFlowControl(const SerialStreamBuf::FlowControlEnum flowControlType) ;

            const SerialStreamBuf::FlowControlEnum FlowControl() ;

            const short SetVMin( short vtime ) ;


            const short VMin() ;

            const short SetVTime( short vtime ) ;

            const short VTime() ;


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

            SerialStreamBuf *mIOBuffer ;

            /* ----------------------------------------------------------------
             * Private Methods
             * ----------------------------------------------------------------
             */
            /* Set the serial port to ignore the modem status lines. If the
               specified boolean parameter is false then the meaning of
               this function is reversed i.e. the serial port will start
               using the modem status lines.

               @param ignore If true then the modem status lines will be
               ignored otherwise they will be used during the
               communication.

            */
            //void IgnoreModemStatusLines(bool ignore=true) ;

            /* Enable the serial port receiver. This will allow us to read
               data from the serial port.
       
               @param enable If true then the received will be
               enabled. Otherwise it will be disabled.

            */
            //void EnableReceiver(bool enable=true) ;

        } ; // class SerialStream

    } // namespace LibSerial
} // extern "C++"
#endif // #ifndef _SerialStream_h_