GroovX: src/visx/response.h Source File

00001 
00003 
00004 //
00005 // Copyright (c) 2000-2004 California Institute of Technology
00006 // Copyright (c) 2004-2007 University of Southern California
00007 // Rob Peters <rjpeters at usc dot edu>
00008 //
00009 // created: Mon Mar 13 18:30:04 2000
00010 // commit: $Id: response.h 10065 2007-04-12 05:54:56Z rjpeters $
00011 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/visx/response.h $
00012 //
00013 // --------------------------------------------------------------------
00014 //
00015 // This file is part of GroovX.
00016 //   [http://ilab.usc.edu/rjpeters/groovx/]
00017 //
00018 // GroovX is free software; you can redistribute it and/or modify it
00019 // under the terms of the GNU General Public License as published by
00020 // the Free Software Foundation; either version 2 of the License, or
00021 // (at your option) any later version.
00022 //
00023 // GroovX is distributed in the hope that it will be useful, but
00024 // WITHOUT ANY WARRANTY; without even the implied warranty of
00025 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00026 // General Public License for more details.
00027 //
00028 // You should have received a copy of the GNU General Public License
00029 // along with GroovX; if not, write to the Free Software Foundation,
00030 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00031 //
00033 
00034 #ifndef GROOVX_VISX_RESPONSE_H_UTC20050626084016_DEFINED
00035 #define GROOVX_VISX_RESPONSE_H_UTC20050626084016_DEFINED
00036 
00037 #include "rutz/value.h"
00038 
00040 class Response : public rutz::value
00041 {
00042 public:
00043   static const int INVALID_VALUE = -1;
00044   static const int ALWAYS_CORRECT = -2;
00045 
00047 
00049   static const int IGNORE = -3;
00050 
00051   Response(int v = INVALID_VALUE, int m = -1) :
00052     itsVal(v), itsMsec(m)
00053   {}
00054 
00055   virtual ~Response() throw();
00056 
00057   virtual rutz::fstring value_typename() const;
00058 
00059   virtual void print_to(std::ostream& os) const;
00060   virtual void scan_from(std::istream& is);
00061 
00062   bool shouldIgnore() const { return itsVal == IGNORE; }
00063 
00064   bool is_valid() const { return (itsVal >= 0); }
00065 
00066   bool matchesCorrectValue(int cval) const
00067   {
00068     return (cval == ALWAYS_CORRECT) || (itsVal == cval);
00069   }
00070 
00071   int val() const { return itsVal; }
00072   int msec() const { return itsMsec; }
00073 
00074   void setVal(int new_val) { itsVal = new_val; }
00075   void setMsec(int new_val) { itsMsec = new_val; }
00076 
00077 private:
00078   int itsVal;
00079   int itsMsec;
00080 };
00081 
00082 static const char __attribute__((used)) vcid_groovx_visx_response_h_utc20050626084016[] = "$Id: response.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00083 #endif // !GROOVX_VISX_RESPONSE_H_UTC20050626084016_DEFINED