trial.h

Go to the documentation of this file.

//
// Copyright (c) 1999-2004 California Institute of Technology
// Copyright (c) 2004-2007 University of Southern California
// Rob Peters <rjpeters at usc dot edu>
//
// created: Mon Mar  1 08:00:00 1999
// commit: $Id: trial.h 10065 2007-04-12 05:54:56Z rjpeters $
// $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/trial.h $
//
// --------------------------------------------------------------------
//
// This file is part of GroovX.
//   [http://ilab.usc.edu/rjpeters/groovx/]
//
// GroovX is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// GroovX is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with GroovX; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
//

#ifndef GROOVX_VISX_TRIAL_H_UTC20050626084016_DEFINED
#define GROOVX_VISX_TRIAL_H_UTC20050626084016_DEFINED

#include "io/fields.h"

#include "rutz/tracer.h"

#include "visx/element.h"

namespace rutz
{
  template <class T> class fwd_iter;
}

namespace nub
{
  template <class T> class ref;
}

class GxNode;
class Response;
class ResponseHandler;
class TimingHdlr;

class Trial : public Element, public FieldContainer
{
public:

  static rutz::tracer tracer;

  // creators //

protected:
  Trial();
public:
  static Trial* make();

  virtual ~Trial () throw();

  virtual io::version_id class_version_id() const;
  virtual void read_from(io::reader& reader);
  virtual void write_to(io::writer& writer) const;

  static const FieldMap& classFields();

  // accessors+manipulators //

  int getCorrectResponse() const;
  void setCorrectResponse(int response);

  nub::ref<ResponseHandler> getResponseHandler() const;
  void setResponseHandler(nub::ref<ResponseHandler> rh);

  nub::ref<TimingHdlr> getTimingHdlr() const;
  void setTimingHdlr(nub::ref<TimingHdlr> th);

  void setType(int t);

  rutz::fwd_iter<Response> responses() const;

  unsigned int numResponses() const;

  void clearResponses();

  double avgResponse() const;
  double avgRespTime() const;

  void addNode(nub::ref<GxNode> item);

  void trNextNode();

  rutz::fwd_iter<nub::ref<GxNode> > nodes() const;

  unsigned int getCurrentNode() const;
  void setCurrentNode(unsigned int nodeNumber);

  void clearObjs();


  rutz::fstring stdInfo() const;


  void setInfo(rutz::fstring info);

  //
  // Element interface
  //

  virtual const nub::soft_ref<Toglet>& getWidget() const;

  virtual int trialType() const;

  virtual int lastResponse() const;

  virtual rutz::fstring vxInfo() const;

  virtual void vxRun(Element& parent);

  virtual void vxHalt() const;

  virtual void vxReturn(ChildStatus s);

  virtual void vxUndo();

  virtual void vxReset();

  // actions //

  double trElapsedMsec();

  void trProcessResponse(Response& response);
  void trDraw();
  void trRender();
  void trUndraw();
  void trSwapBuffers();
  void trRenderBack();
  void trRenderFront();
  void trClearBuffer();
  void trFinishDrawing();
  void trAllowResponses();
  void trDenyResponses();
  void trAbortTrial();
  void trEndTrial();

private:
  Trial(const Trial&);
  Trial& operator=(const Trial&);

  class Impl;
  Impl* const rep;
};

static const char __attribute__((used)) vcid_groovx_visx_trial_h_utc20050626084016[] = "$Id: trial.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
#endif // !GROOVX_VISX_TRIAL_H_UTC20050626084016_DEFINED

---

The software described here is Copyright (c) 1998-2005, Rob Peters.
This page was generated Wed Dec 3 06:49:42 2008 by Doxygen version 1.5.5.