GroovX: src/visx/elementcontainer.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: Thu Dec  5 16:43:50 2002
00011 // commit: $Id: elementcontainer.h 10065 2007-04-12 05:54:56Z rjpeters $
00012 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/elementcontainer.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_ELEMENTCONTAINER_H_UTC20050626084016_DEFINED
00036 #define GROOVX_VISX_ELEMENTCONTAINER_H_UTC20050626084016_DEFINED
00037 
00038 #include "visx/element.h"
00039 
00040 namespace rutz
00041 {
00042   template <class T> class fwd_iter;
00043 }
00044 
00045 namespace nub
00046 {
00047   template <class T> class ref;
00048   template <class T> class soft_ref;
00049 }
00050 
00052 
00053 class ElementContainer: public Element
00054 {
00055 public:
00057   ElementContainer();
00058 
00060   virtual ~ElementContainer() throw();
00061 
00062   virtual void read_from(io::reader& reader);
00063 
00064   virtual void write_to(io::writer& writer) const;
00065 
00066   //
00067   // Element base interface
00068   //
00069 
00071   virtual int trialType() const;
00072 
00074 
00075   virtual int lastResponse() const;
00076 
00078   virtual rutz::fstring vxInfo() const;
00079 
00081   virtual void vxHalt() const;
00082 
00084   virtual void vxReturn(ChildStatus s);
00085 
00087 
00093   virtual void vxUndo();
00094 
00096   virtual void vxReset();
00097 
00098   //
00099   // Container interface
00100   //
00101 
00103   void addElement(nub::ref<Element> element, unsigned int repeat = 1);
00104 
00106   void setRandSeed(int s);
00107 
00109   int getRandSeed() const;
00110 
00112 
00113   void shuffle(int seed=0);
00114 
00116   void clearElements();
00117 
00119   nub::soft_ref<Element> currentElement() const;
00120 
00122   unsigned int numElements() const;
00123 
00125 
00127   unsigned int numCompleted() const;
00128 
00130   rutz::fwd_iter<const nub::ref<Element> > getElements() const;
00131 
00133   bool isComplete() const;
00134 
00135 protected:
00137   virtual void vxAllChildrenFinished() = 0;
00138 
00139 private:
00140   class Impl;
00141   Impl* const rep;
00142 };
00143 
00144 static const char __attribute__((used)) vcid_groovx_visx_elementcontainer_h_utc20050626084016[] = "$Id: elementcontainer.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00145 #endif // !GROOVX_VISX_ELEMENTCONTAINER_H_UTC20050626084016_DEFINED