KeyBoard.H

Go to the documentation of this file.
00001 /*!@file Devices/KeyBoard.H a simple keyboard interface */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2003   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Naila Rizvi <nrizvi@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Devices/KeyBoard.H $
00035 // $Id: KeyBoard.H 13695 2010-07-25 18:19:38Z dberg $
00036 //
00037 
00038 #ifndef KEYBOARD_H_DEFINED
00039 #define KEYBOARD_H_DEFINED
00040 
00041 #include <termios.h>
00042 
00043 //! Possible keys returned by our access methods
00044 enum KeyBoardKey {
00045   KBD_NONE, KBD_KEY1, KBD_KEY2, KBD_KEY3, KBD_KEY4, KBD_KEY5, KBD_OTHER
00046 };
00047 
00048 
00049 //! Simple interface to a keyboard
00050 /*! This class provides basic methods to check whether a key was
00051   pressed on the keyboard. It is used by the Beobot, which has a small
00052   keypad with just 5 keys. */
00053 class KeyBoard
00054 {
00055 public:
00056   //! Constructor
00057   KeyBoard();
00058 
00059   //! Destructor
00060   ~KeyBoard();
00061 
00062   //! Get a key from the keyboard
00063   /*! @param block if true, this function will block until a key is
00064     pressed. Otherwise, it will return the key pressed if any, or
00065     KBD_NONE if no key was pressed. */
00066   KeyBoardKey getKey(const bool block);
00067   
00068   //! get the key from the keybard and return as an int
00069   /*! @param block if true, this function will block until a key is
00070     pressed. */
00071   int getKeyAsChar(const bool block);
00072   
00073 private:
00074   // Enable/disables blocking mode
00075   void setBlocking(const bool block);
00076 
00077   // convert from char to KeyBoardKey
00078   KeyBoardKey fromChar(const char c) const;
00079 
00080   struct termios stored_settings;
00081   bool blocking;  // keep track of whether we are blocking or not
00082 };
00083 
00084 #endif
00085 
00086 // ######################################################################
00087 /* So things look consistent in everyone's emacs... */
00088 /* Local Variables: */
00089 /* indent-tabs-mode: nil */
00090 /* End: */
Generated on Sun May 8 08:40:37 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3