GroovX: src/visx/timinghdlr.h Source File

00001 
00004 
00005 //
00006 // Copyright (c) 1999-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: Mon Jun 21 13:09:55 1999
00011 // commit: $Id: timinghdlr.h 10065 2007-04-12 05:54:56Z rjpeters $
00012 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/timinghdlr.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_TIMINGHDLR_H_UTC20050626084015_DEFINED
00036 #define GROOVX_VISX_TIMINGHDLR_H_UTC20050626084015_DEFINED
00037 
00038 #include "io/io.h"
00039 
00040 namespace nub
00041 {
00042   template <class T> class ref;
00043   template <class T> class soft_ref;
00044 }
00045 
00046 class Trial;
00047 class TrialEvent;
00048 
00049 //  #######################################################
00050 //  =======================================================
00051 
00053 class TimingHdlr : public io::serializable
00054 {
00055 protected:
00056   TimingHdlr();
00057 public:
00058   static TimingHdlr* make();
00059   virtual ~TimingHdlr() throw();
00060 
00061   virtual io::version_id class_version_id() const;
00062   virtual void read_from(io::reader& reader);
00063   virtual void write_to(io::writer& writer) const;
00064 
00065   typedef int TimePoint;
00066   static const TimePoint IMMEDIATE=0;
00067   static const TimePoint FROM_START=1;
00068   static const TimePoint FROM_RESPONSE=2;
00069   static const TimePoint FROM_ABORT=3;
00070 
00072   // accessors //
00074 
00075   nub::ref<TrialEvent> getEvent(TimePoint time_point,
00076                                 unsigned int index) const;
00077 
00080   double getElapsedMsec() const;
00081 
00083   // manipulators //
00085 
00086   unsigned int addEvent(nub::ref<TrialEvent> event,
00087                         TimePoint time_point);
00088   unsigned int addEventByName(const char* event_type,
00089                               TimePoint time_point, int msec_delay);
00090 
00092   // actions //
00094 
00095   void thBeginTrial(Trial& trial);
00096   void thResponseSeen();
00097   void thAbortTrial();
00098   void thEndTrial();
00099 
00100   void thHaltExpt();
00101 
00102 private:
00103   TimingHdlr(const TimingHdlr&);
00104   TimingHdlr& operator=(const TimingHdlr&);
00105 
00106   class Impl;
00107   Impl* const rep;
00108 };
00109 
00110 static const char __attribute__((used)) vcid_groovx_visx_timinghdlr_h_utc20050626084015[] = "$Id: timinghdlr.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00111 #endif // !GROOVX_VISX_TIMINGHDLR_H_UTC20050626084015_DEFINED