AnalogProxy.h

Go to the documentation of this file.

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2006-12-09 13:42:12 -0600 (Sat, 09 Dec 2006) $
 * Version:       $Revision: 19596 $
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

//
// positional proxy class
//

#ifndef _GADGET_ANALOGPROXY_H_
#define _GADGET_ANALOGPROXY_H_

#include <gadget/gadgetConfig.h>
#include <gadget/Type/Analog.h>
#include <gadget/Type/Proxy.h>
#include <gadget/Type/AnalogData.h>

namespace gadget
{

class GADGET_CLASS_API AnalogProxy : public TypedProxy<Analog>
{

public:
   AnalogProxy()
      : mUnitNum(-1)
      , mData(-1.0f)
   {;}

   virtual ~AnalogProxy()
   {;}

   virtual void updateData()
   {
      if(!isStupefied())
      {
         // Make sure dependencies are updated.
         getProxiedInputDevice()->updateDataIfNeeded();
         mData = mTypedDevice->getAnalogData(mUnitNum);
      }
   }

   virtual vpr::Interval getTimeStamp() const
   {
      return mData.getTime();
   }

   float getData() const
   {
      const float analogDefault(0.0f);
      if(isStupefied())
      {
         return analogDefault;
      }
      else
      {
         return mData.getAnalog();
      }
   }

   Analog* getAnalogPtr()
   {
      if(isStupefied())
      {
         return NULL;
      }
      else
      {
         return mTypedDevice;
      }
   }

   int getUnit() const
   {
      return mUnitNum;
   }

   static std::string getElementType();

   bool config(jccl::ConfigElementPtr element);

   virtual Input* getProxiedInputDevice()
   {
      if((NULL == mTypedDevice) || (mStupefied))
      {
         return NULL;
      }

      Input* ret_val = dynamic_cast<Input*>(mTypedDevice);
      vprASSERT((ret_val != NULL) && "Cross-cast in AnalogProxy failed");
      return ret_val;
   }

private:
   int         mUnitNum;
   AnalogData  mData;
};

} // End of gadget namespace

#endif

---