gadget::SimAnalog Class Reference

Simulated analog device. More...

#include <gadget/Devices/Sim/SimAnalog.h>

Inheritance diagram for gadget::SimAnalog:

[legend]Collaboration diagram for gadget::SimAnalog:

[legend]List of all members.

Public Member Functions
	SimAnalog ()
	Default Constructor.
virtual	~SimAnalog ()
	Destructor.
virtual bool	config (jccl::ConfigElementPtr element)
	Reads the minimum and maximum value configuration information for this analog device.
bool	startSampling ()
	These functions don't do anything.
bool	stopSampling ()
bool	sample ()
virtual void	updateData ()
	Updates the data.
virtual std::vector< KeyModPair >	getUpKeys ()
virtual std::vector< KeyModPair >	getDownKeys ()
void	operator delete (void *p)
	Invokes the global scope delete operator.
Static Public Member Functions
static std::string	getElementType ()
Protected Member Functions
virtual void	destroy ()
	Deletes this object.

---

Detailed Description

Simulated analog device.

Simulates an analog device from a keyboard device. It allows any number of simulated analog devices to be created.

This class should not be used directly by the user.

Definition at line 59 of file SimAnalog.h.

---

Constructor & Destructor Documentation

gadget::SimAnalog::SimAnalog

(

)

Default Constructor.

Definition at line 40 of file SimAnalog.cpp.

   : mAnaStep(0.0f)
   , mInitialValue(0.0f)
{
   //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimAnalog::SimPinchGlove()\n"<< vprDEBUG_FLUSH;
}

gadget::SimAnalog::~SimAnalog

(

)

[virtual]

Destructor.

Definition at line 48 of file SimAnalog.cpp.

{
   //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimAnalog::~SimPinchGlove()\n"<< vprDEBUG_FLUSH;
}

---

Member Function Documentation

bool gadget::SimAnalog::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Reads the minimum and maximum value configuration information for this analog device.

Parameters:

element

The config element for an analog device. It must derive from the base config element type 'analog'.

Definition at line 58 of file SimAnalog.cpp.

References gadget::SimInput::config(), gadget::Analog::config(), and gadget::Input::config().

{
   //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimAnalog::config()\n"<< vprDEBUG_FLUSH;
   if (! (Input::config(element) && Analog::config(element) &&
          SimInput::config(element)) )
   {
      return false;
   }

   std::vector<jccl::ConfigElementPtr> key_inc_list, key_dec_list;

   int key_count = element->getNum("increment_keypress");

   for ( int i = 0; i < key_count; ++i )
   {
      key_inc_list.push_back(element->getProperty<jccl::ConfigElementPtr>("increment_keypress", i));
   }

   key_count = element->getNum("decrement_keypress");

   for ( int i = 0; i < key_count; ++i )
   {
      key_dec_list.push_back(element->getProperty<jccl::ConfigElementPtr>("decrement_keypress", i));
   }

   mSimKeysUp = readKeyList(key_inc_list);
   mSimKeysDown = readKeyList(key_dec_list);

   mAnaStep = element->getProperty<float>("delta");
   mInitialValue = element->getProperty<float>("initial_value");

   // Initialize all the data to the inital_value
   size_t num_pairs = mSimKeysUp.size();
   mAnaData = std::vector<AnalogData>(num_pairs);
   for (size_t i=0; i<num_pairs; ++i)
   {
      mAnaData[i].setAnalog(mInitialValue);
   }

   return true;
}

bool gadget::SimAnalog::startSampling

(

)

[inline]

These functions don't do anything.

Definition at line 76 of file SimAnalog.h.

   {
      return true;
   }

bool gadget::SimAnalog::stopSampling

(

)

[inline]

Definition at line 81 of file SimAnalog.h.

   {
      return true;
   }

bool gadget::SimAnalog::sample

(

)

[inline]

Definition at line 86 of file SimAnalog.h.

   {
      return true;
   }

void gadget::SimAnalog::updateData

(

)

[virtual]

Updates the data.

Definition at line 100 of file SimAnalog.cpp.

{
   //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimAnalog::updateData()\n"<< vprDEBUG_FLUSH;

   // Make an list of the data that will be normalized
   std::vector<AnalogData> norm_data(mAnaData.size());

   // -- Update analog data --- //
   for (unsigned int i = 0; i < mSimKeysUp.size(); ++i)
   {
      mAnaData[i].setTime();
      mAnaData[i].setAnalog(mAnaData[i].getAnalog()
                                + (float)checkKeyPair(mSimKeysUp[i]) * mAnaStep);
      mAnaData[i].setAnalog(mAnaData[i].getAnalog()
                                - (float)checkKeyPair(mSimKeysDown[i]) * mAnaStep);

      // Clamp to the min/max range
      mAnaData[i].setAnalog(gmtl::Math::clamp(mAnaData[i].getAnalog(),
                                              getMin(), getMax()));

      float normalized_value;
      normalizeMinToMax(mAnaData[i].getAnalog(), normalized_value);

      // Set the normalized data
      norm_data[i] = normalized_value;
      norm_data[i].setTime(mKeyboardMouse->getTimeStamp());
   }

   // Locks and then swaps the indices.
   addAnalogSample(norm_data);
   swapAnalogBuffers();
}

std::string gadget::SimAnalog::getElementType

(

)

[static]

Definition at line 53 of file SimAnalog.cpp.

{
   return "simulated_analog_device";
}

virtual std::vector<KeyModPair> gadget::SimAnalog::getUpKeys

(

)

[inline, virtual]

Definition at line 96 of file SimAnalog.h.

   {
      return mSimKeysUp;
   }

virtual std::vector<KeyModPair> gadget::SimAnalog::getDownKeys

(

)

[inline, virtual]

Definition at line 101 of file SimAnalog.h.

   {
      return mSimKeysDown;
   }

void gadget::SimAnalog::operator delete

(

void *

p

)

[inline]

Invokes the global scope delete operator.

This is required for proper releasing of memory in DLLs on Win32.

Definition at line 110 of file SimAnalog.h.

   {
      ::operator delete(p);
   }

virtual void gadget::SimAnalog::destroy

(

)

[inline, protected, virtual]

Deletes this object.

This is an implementation of the pure virtual gadget::Input::destroy() method.

Definition at line 120 of file SimAnalog.h.

   {
      delete this;
   }

---

The documentation for this class was generated from the following files:

• SimAnalog.h
• SimAnalog.cpp

---