Analog.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: 2005-01-15 18:00:37 -0600 (Sat, 15 Jan 2005) $
 * Version:       $Revision: 16622 $
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _GADGET_ANALOG_H_
#define _GADGET_ANALOG_H_

#include <gadget/gadgetConfig.h>
#include <vector>

#include <gadget/Type/AnalogData.h>
#include <gadget/Type/SampleBuffer.h>

#include <jccl/Config/ConfigElement.h>
#include <vpr/IO/SerializableObject.h>


namespace gadget
{

const unsigned short MSG_DATA_ANALOG = 421;

class GADGET_CLASS_API Analog : public vpr::SerializableObject
{
public:
   typedef gadget::SampleBuffer<AnalogData> SampleBuffer_t;

public:

   Analog();

   virtual ~Analog();

   virtual vpr::ReturnStatus writeObject(vpr::ObjectWriter* writer);

   virtual vpr::ReturnStatus readObject(vpr::ObjectReader* reader);

   virtual bool config(jccl::ConfigElementPtr element);

   AnalogData getAnalogData(int devNum = 0);

   void addAnalogSample(const std::vector< AnalogData >& anaSample);

   void swapAnalogBuffers();

   const SampleBuffer_t::buffer_t& getAnalogDataBuffer();

   virtual std::string getInputTypeName();

protected:
   void normalizeMinToMax(const float& plainJaneValue,
                          float& normedFromMinToMax);

protected:
   float getMin() const;
   float getMax() const;
   void setMin(float mIn);
   void setMax(float mAx);

   // gadget::SampleBuffer<T> is not copyable, so neither are we.
   Analog(const gadget::Analog& d)
      : vpr::SerializableObject(d)
   {;}

   void operator=(const gadget::Analog&) {;}

private:
   float mMin, mMax;

private:
   SampleBuffer_t    mAnalogSamples;  
   AnalogData        mDefaultValue;   
};

} // End of gadget namespace


#endif   /* _GADGET_ANALOG_H_ */

---