GroovX: src/visx/element.h Source File

00001 
00004 
00005 //
00006 // Copyright (c) 2002-2004 California Institute of Technology
00007 // Copyright (c) 2004-2007 University of Southern California
00008 // Rob Peters <rjpeters at usc dot edu>
00009 //
00010 // created: Wed Dec  4 15:35:37 2002
00011 // commit: $Id: element.h 10065 2007-04-12 05:54:56Z rjpeters $
00012 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/element.h $
00013 //
00014 // --------------------------------------------------------------------
00015 //
00016 // This file is part of GroovX.
00017 //   [http://ilab.usc.edu/rjpeters/groovx/]
00018 //
00019 // GroovX is free software; you can redistribute it and/or modify it
00020 // under the terms of the GNU General Public License as published by
00021 // the Free Software Foundation; either version 2 of the License, or
00022 // (at your option) any later version.
00023 //
00024 // GroovX is distributed in the hope that it will be useful, but
00025 // WITHOUT ANY WARRANTY; without even the implied warranty of
00026 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00027 // General Public License for more details.
00028 //
00029 // You should have received a copy of the GNU General Public License
00030 // along with GroovX; if not, write to the Free Software Foundation,
00031 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00032 //
00034 
00035 #ifndef GROOVX_VISX_ELEMENT_H_UTC20050626084015_DEFINED
00036 #define GROOVX_VISX_ELEMENT_H_UTC20050626084015_DEFINED
00037 
00038 #include "io/io.h"
00039 
00040 namespace nub
00041 {
00042   template <class T> class soft_ref;
00043 }
00044 
00045 namespace rutz
00046 {
00047   class fstring;
00048 }
00049 
00050 class Toglet;
00051 
00052 //  #######################################################
00053 //  =======================================================
00054 
00056 
00059 class Element : public io::serializable
00060 {
00061 public:
00063   virtual ~Element() throw();
00064 
00066   enum ChildStatus
00067     {
00068       CHILD_OK,
00069       CHILD_ABORTED,
00070       CHILD_REPEAT
00071     };
00072 
00074   virtual const nub::soft_ref<Toglet>& getWidget() const = 0;
00075 
00077   virtual int trialType() const = 0;
00078 
00080   virtual int lastResponse() const = 0;
00081 
00083   virtual rutz::fstring vxInfo() const = 0;
00084 
00086   virtual void vxRun(Element& parent) = 0;
00087 
00089   virtual void vxHalt() const = 0;
00090 
00092 
00094   virtual void vxEndTrialHook();
00095 
00097   virtual void vxReturn(ChildStatus s) = 0;
00098 
00100   virtual void vxUndo() = 0;
00101 
00103   virtual void vxReset() = 0;
00104 };
00105 
00106 static const char __attribute__((used)) vcid_groovx_visx_element_h_utc20050626084015[] = "$Id: element.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00107 #endif // !GROOVX_VISX_ELEMENT_H_UTC20050626084015_DEFINED