Main MRPT website > C++ reference
MRPT logo

CEvent.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  mrpt_synch_event_H
00029 #define  mrpt_synch_event_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/utils/CStream.h>
00033 #include <mrpt/utils/CReferencedMemBlock.h>
00034 
00035 /*---------------------------------------------------------------
00036         Class
00037   ---------------------------------------------------------------*/
00038 namespace mrpt
00039 {
00040         /** This namespace provides multitask, synchronization utilities.
00041          */
00042         namespace synch
00043         {
00044                 /** This class provides a simple way of waiting for and signaling events (NOT IMPLEMENTED YET!).
00045                   */
00046                 class BASE_IMPEXP CEvent
00047                 {
00048                 private:
00049                         utils::CReferencedMemBlock              m_data;
00050 
00051                 public:
00052                         /** Constructor: set the initial signaled state of the event.
00053                           */
00054                         CEvent( bool initialSignaled );
00055 
00056                         /** Destructor
00057                           */
00058                         ~CEvent();
00059 
00060                         /** Signal the event: the first waiting thread resumes execution (if no thread is waiting, the object keeps signaled)
00061                           */
00062                         void  signal();
00063 
00064                         /** Waits for the event to be signaled.
00065                           */
00066                         void  wait();
00067 
00068                         /** Manual reset of the event, without waiting to a signaled state (without effect if it is currently not signaled)
00069                           */
00070                         void  reset();
00071                 };
00072 
00073         } // End of namespace
00074 
00075 } // End of namespace
00076 
00077 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011