Agent.H

Go to the documentation of this file.
00001 /*!@file SeaBee/Agent.H
00002  base class for agents. Has run function for thread running             */
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
00005 // 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: Michael Montalbo <montalbo@usc.edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/SeaBee/Agent.H $
00035 // $Id: Agent.H 9797 2008-06-07 22:09:04Z beobot $
00036 //
00037 //////////////////////////////////////////////////////////////////////////
00038 
00039 #ifndef __AGENT_H__
00040 #define __AGENT_H__
00041 
00042 #include <pthread.h>
00043 #include <string>
00044 
00045 #include "Globals.H"
00046 
00047 class Agent
00048 {
00049 public:
00050 
00051   // ######################################################################
00052   /*! @name Constructors and Destructors */
00053   //@{
00054 
00055   Agent(std::string name);
00056   virtual ~Agent();
00057 
00058   //@}
00059 
00060   // ######################################################################
00061   //! @name Access functions
00062   //@{
00063 
00064   //! get the name of the agent
00065   inline std::string getName();
00066 
00067   //@}
00068 
00069   // ######################################################################
00070   /*! @name member functions */
00071   //@{
00072 
00073   virtual bool pickAndExecuteAnAction();
00074   bool isAsleep();
00075   void acquire();
00076   void run();
00077 
00078   void Do(std::string msg);
00079 
00080   //@}
00081 
00082 
00083 protected:
00084 
00085   //! updates the agent's stateChange
00086   void stateChanged();
00087   pthread_mutex_t itsStateChangedLock;
00088 
00089   //! the name of the agent
00090   std::string itsName;
00091 
00092   //! indicates that the agent's state has changed
00093   volatile int stateChange;
00094 
00095   std::string itsLastAction;
00096 
00097 };
00098 
00099 // ######################################################################
00100 // Implementation for Agent inline functions
00101 // ######################################################################
00102 inline std::string Agent::getName()
00103 {
00104   return itsName;
00105 }
00106 #endif
00107 
00108 // ######################################################################
00109 /* So things look consistent in everyone's emacs... */
00110 /* Local Variables: */
00111 /* indent-tabs-mode: nil */
00112 /* End: */
00113 
00114 
00115 
Generated on Sun May 8 08:40:15 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3