gadget::SimDigital Class Reference

Simulated digital device. More...

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

Inheritance diagram for gadget::SimDigital:

[legend]Collaboration diagram for gadget::SimDigital:

[legend]List of all members.

Public Member Functions
	SimDigital ()
	Default Constructor.
virtual	~SimDigital ()
	Destructor.
virtual bool	config (jccl::ConfigElementPtr element)
virtual bool	startSampling ()
	These functions don't do anything.
virtual bool	stopSampling ()
virtual bool	sample ()
virtual void	updateData ()
	Updates the state of the digital data vector.
virtual std::vector< KeyModPair >	getKeys ()
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 digital device.

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

When the key configured is held down, the digital device is on. When the key is released, the device is no longer set.

This class should not be used directly by the user.

Definition at line 59 of file SimDigital.h.

---

Constructor & Destructor Documentation

gadget::SimDigital::SimDigital

(

)

Default Constructor.

Definition at line 41 of file SimDigital.cpp.

{
   vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimDigital::SimDigital()\n"<< vprDEBUG_FLUSH;
}

gadget::SimDigital::~SimDigital

(

)

[virtual]

Destructor.

Definition at line 47 of file SimDigital.cpp.

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

---

Member Function Documentation

bool gadget::SimDigital::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Definition at line 57 of file SimDigital.cpp.

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

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

   std::vector<jccl::ConfigElementPtr> key_list;
   int key_count = element->getNum("key_pair");
   for ( int i = 0; i < key_count; ++i )
   {
      key_list.push_back(element->getProperty<jccl::ConfigElementPtr>("key_pair", i));
   }
   mSimKeys = readKeyList(key_list);

   return true;
}

virtual bool gadget::SimDigital::startSampling

(

)

[inline, virtual]

These functions don't do anything.

Definition at line 68 of file SimDigital.h.

{ return 1; }

virtual bool gadget::SimDigital::stopSampling

(

)

[inline, virtual]

Definition at line 69 of file SimDigital.h.

{ return 1; }

virtual bool gadget::SimDigital::sample

(

)

[inline, virtual]

Definition at line 70 of file SimDigital.h.

{ return 1; }

void gadget::SimDigital::updateData

(

)

[virtual]

Updates the state of the digital data vector.

Note:

Digital is on when key is held down. When key is release, digital goes to off state.

Definition at line 83 of file SimDigital.cpp.

{
   //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimDigital::updateData()\n"<< vprDEBUG_FLUSH;
   std::vector<DigitalData>  digital_data_sample(mSimKeys.size());   // The digital data that makes up the sample

   // -- Update digital data --- //
   for (unsigned int i = 0; i < mSimKeys.size(); i++)
   {
      // Set the time for the digital data to the KeyboardMouse timestamp
      digital_data_sample[i].setTime(mKeyboardMouse->getTimeStamp());
      if(checkKeyPair(mSimKeys[i]))             // If keys pressed
      {
         digital_data_sample[i] = 1;
      }
      else
      {
         digital_data_sample[i] = 0;
      }
   }

   // Add a sample
   addDigitalSample(digital_data_sample);
      
   swapDigitalBuffers();
}

std::string gadget::SimDigital::getElementType

(

)

[static]

Definition at line 52 of file SimDigital.cpp.

{
   return "simulated_digital_device";
}

virtual std::vector<KeyModPair> gadget::SimDigital::getKeys

(

)

[inline, virtual]

Definition at line 77 of file SimDigital.h.

{ return mSimKeys; }

void gadget::SimDigital::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 83 of file SimDigital.h.

   {
      ::operator delete(p);
   }

virtual void gadget::SimDigital::destroy

(

)

[inline, protected, virtual]

Deletes this object.

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

Definition at line 93 of file SimDigital.h.

   {
      delete this;
   }

---

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

• SimDigital.h
• SimDigital.cpp

---