Event.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  Event.h
//
//  Cross-platform manual-reset event
//
//  Copyright (c) 2010 Mal Lansell <mal@lansell.org>
//  All rights reserved.
//
//  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 _Event_H
#define _Event_H
 
#include "platform/Wait.h"
 
namespace OpenZWave
{
    class EventImpl;

    class Event: public Wait
    {
        friend class SerialControllerImpl;
        friend class Wait;
 
    public:
        Event();

        void Set();

        void Reset();
 
    protected:
        virtual bool IsSignalled();

        bool Wait( int32 _timeout );

        ~Event();
 
    private:
        Event( Event const&   );                  // prevent copy
        Event& operator = ( Event const& );       // prevent assignment
 
        EventImpl*  m_pImpl;    // Pointer to an object that encapsulates the platform-specific implementation of a event.
    };
 
} // namespace OpenZWave
 
#endif //_Event_H