SerialController.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  SerialController.h
//
//  Cross-platform serial port handler
//
//  Copyright (c) 2010 Jason Frazier <frazierjason@gmail.com>
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
 
#ifndef _SerialController_H
#define _SerialController_H
 
#include <string>
#include "Defs.h"
#include "platform/Controller.h"
 
namespace OpenZWave
{
    class Driver;
    class Msg;
    class SerialControllerImpl;
 
    class SerialController: public Controller
    {
        friend class SerialControllerImpl;
 
    public:
        enum Parity
        {
            Parity_None = 0,
            Parity_Odd,
            Parity_Even,
            Parity_Mark,
            Parity_Space
        };
 
        enum StopBits
        {
            StopBits_One = 0,
            StopBits_OneAndAHalf = 1,
            StopBits_Two = 2
        };

        SerialController();

        virtual ~SerialController();

        bool SetBaud( uint32 const _baud );

        bool SetParity( Parity const _parity );

        bool SetStopBits( StopBits const _stopBits );

        bool Open( string const& _SerialControllerName );

        bool Close();

        uint32 Write( uint8* _buffer, uint32 _length );
 
    private:
        uint32                      m_baud;
        SerialController::Parity    m_parity;
        SerialController::StopBits  m_stopBits;
        string                      m_serialControllerName;
 
        SerialControllerImpl*       m_pImpl;    // Pointer to an object that encapsulates the platform-specific implementation of the serial port.
        bool                        m_bOpen;
    };
 
} // namespace OpenZWave
 
#endif //_SerialController_H