gadget::Digital Class Reference

Digital is the abstract base class from which devices with digital data derive (through gadget::InputMixer). More...

#include <gadget/Type/Digital.h>

Inheritance diagram for gadget::Digital:

[legend]Collaboration diagram for gadget::Digital:

[legend]List of all members.

Public Types
enum	State { OFF = 0, ON = 1, TOGGLE_ON = 2, TOGGLE_OFF = 3 }
	Enum for the state of the digital buttons. More...
typedef gadget::SampleBuffer< DigitalData >	SampleBuffer_t
Public Member Functions
	Digital ()
virtual	~Digital ()
virtual bool	config (jccl::ConfigElementPtr e)
const DigitalData	getDigitalData (int devNum=0)
	Gets the digital data for the given devNum.
void	addDigitalSample (const std::vector< DigitalData > &digSample)
	Helper method to add a collection of digital samples to the sample buffers.
void	swapDigitalBuffers ()
	Swaps the digital data buffers.
const SampleBuffer_t::buffer_t &	getDigitalDataBuffer ()
	Returns the current stable sample buffers for this device.
virtual std::string	getInputTypeName ()
virtual vpr::ReturnStatus	writeObject (vpr::ObjectWriter *writer)
	Serializes this object.
virtual vpr::ReturnStatus	readObject (vpr::ObjectReader *reader)
	De-serializes this object.
Protected Member Functions
	Digital (const gadget::Digital &d)
void	operator= (const gadget::Digital &)

---

Detailed Description

Digital is the abstract base class from which devices with digital data derive (through gadget::InputMixer).

This is in addition to gadget::Input. gadget::Input provides pure virtual function constraints in the following functions: startSampling(), stopSampling(), sample(), and updateData().

gadget::Digital adds the function getDigitalData() for retreiving the received digital data. This is similar to the additions made by gadget::Position and gadget::Analog.

See also:

Input, InputMixer

Definition at line 66 of file Digital.h.

---

Member Typedef Documentation

typedef gadget::SampleBuffer<DigitalData> gadget::Digital::SampleBuffer_t

Definition at line 69 of file Digital.h.

---

Member Enumeration Documentation

enum gadget::Digital::State

Enum for the state of the digital buttons.

Used in DigitalProxy.

Enumerator:

OFF	Device is in the "off" state.
ON	Device is in the "on" state.
TOGGLE_ON	Device was in the "off" state and has changed to "on" since the last frame.
TOGGLE_OFF	Device was in the "on" state and has changed to "off" since the last frame.

Definition at line 76 of file Digital.h.

      {
         OFF = 0,       
         ON = 1,        
         TOGGLE_ON = 2, 
         TOGGLE_OFF = 3 
      };

---

Constructor & Destructor Documentation

gadget::Digital::Digital

(

)

[inline]

Definition at line 88 of file Digital.h.

      {
         ;
      }

virtual gadget::Digital::~Digital

(

)

[inline, virtual]

Definition at line 93 of file Digital.h.

      {
      }

gadget::Digital::Digital

(

const gadget::Digital &

d

)

[inline, protected]

Definition at line 164 of file Digital.h.

: vpr::SerializableObject(d) {;}

---

Member Function Documentation

virtual bool gadget::Digital::config

(

jccl::ConfigElementPtr

e

)

[inline, virtual]

Reimplemented in gadget::SimGloveGesture.

Definition at line 97 of file Digital.h.

Referenced by gadget::SimDigitalGlove::config(), and gadget::SimDigital::config().

      {
         boost::ignore_unused_variable_warning(e);
         return true;
      }

const DigitalData gadget::Digital::getDigitalData

(

int

devNum = 0

)

Gets the digital data for the given devNum.

Returns:

Digital 0 or 1, if devNum makes sense. -1 is returned if function fails or if devNum is out of range.

Note:

If devNum is out of range, function will fail, possibly issuing an error to a log or console - but will not ASSERT.

Reimplemented in gadget::SimGloveGesture.

Definition at line 48 of file Digital.cpp.

References gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::stableBuffer().

{
   SampleBuffer_t::buffer_t& stable_buffer = mDigitalSamples.stableBuffer();

   if ( (!stable_buffer.empty()) &&
        (stable_buffer.back().size() > (unsigned)devNum) )  // If Have entry && devNum in range
   {
      return stable_buffer.back()[devNum];
   }
   else        // No data or request out of range, return default value
   {
      if ( stable_buffer.empty() )
      {
         vprDEBUG(vprDBG_ALL, vprDBG_WARNING_LVL)
            << "WARNING: [gadget::Digital::getDigitalData()] "
            << "Stable buffer is empty.  If this is not the first "
            << "read, then this is a problem.\n" << vprDEBUG_FLUSH;
      }
      else
      {
         vprDEBUG(vprDBG_ALL, vprDBG_CONFIG_LVL)
            << "WARNING: [gadget::Digital::getDigitalData()] "
            << "Requested devNum (" << devNum
            << ") is not in the range available.  "
            << "This is probably a configuration error.\n"
            << vprDEBUG_FLUSH;
      }
      return mDefaultValue;
   }
}

void gadget::Digital::addDigitalSample

(

const std::vector< DigitalData > &

digSample

)

[inline]

Helper method to add a collection of digital samples to the sample buffers.

This MUST be called by all digital devices to add new samples.

Postcondition:

The given digital samples are added to the buffers.

Parameters:

digSample

A vector of DigitalData objects that represent the newest samples taken.

Definition at line 124 of file Digital.h.

      {
         // Locks and then swaps the indices.
         mDigitalSamples.lock();
         mDigitalSamples.addSample(digSample);
         mDigitalSamples.unlock();
      }

void gadget::Digital::swapDigitalBuffers

(

)

[inline]

Swaps the digital data buffers.

Postcondition:

If the ready queue has values, then those values are copied from the ready queue to the stable queue. If not, then stable queue is not changed.

Definition at line 139 of file Digital.h.

      {
         mDigitalSamples.swapBuffers();
      }

const SampleBuffer_t::buffer_t& gadget::Digital::getDigitalDataBuffer

(

)

[inline]

Returns the current stable sample buffers for this device.

Definition at line 147 of file Digital.h.

      {
         return mDigitalSamples.stableBuffer();
      }

virtual std::string gadget::Digital::getInputTypeName

(

)

[inline, virtual]

Reimplemented in gadget::InputMixer< gadget::InputMixer< gadget::SimInput, gadget::Input >, gadget::Digital >.

Definition at line 151 of file Digital.h.

Referenced by readObject(), and writeObject().

      {
         return std::string("Digital");
      }

vpr::ReturnStatus gadget::Digital::writeObject

(

vpr::ObjectWriter *

writer

)

[virtual]

Serializes this object.

Reimplemented in gadget::InputMixer< gadget::InputMixer< gadget::SimInput, gadget::Input >, gadget::Digital >.

Definition at line 79 of file Digital.cpp.

References gadget::tokens::BufferSampleLenAttrib(), gadget::tokens::BufferSampleTag(), gadget::tokens::DataTypeAttrib(), gadget::tokens::DigitalValue(), getInputTypeName(), gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::lock(), gadget::MSG_DATA_DIGITAL, gadget::tokens::SampleBufferLenAttrib(), gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::stableBuffer(), gadget::tokens::TimeStamp(), and gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::unlock().

{
   writer->beginTag(Digital::getInputTypeName());
   //std::cout << "[Remote Input Manager] In Digital write" << std::endl;
   SampleBuffer_t::buffer_t& stable_buffer = mDigitalSamples.stableBuffer();
   writer->beginAttribute(gadget::tokens::DataTypeAttrib);
      writer->writeUint16(MSG_DATA_DIGITAL);                               // Write out the data type so that we can assert if reading in wrong place
   writer->endAttribute();

   writer->beginAttribute(gadget::tokens::SampleBufferLenAttrib);
      writer->writeUint16(stable_buffer.size());                           // Write the # of vectors in the stable buffer
   writer->endAttribute();

   if ( !stable_buffer.empty() )
   {
      mDigitalSamples.lock();
      for ( unsigned j=0;j<stable_buffer.size();j++ )                               // For each vector in the stable buffer
      {
         writer->beginTag(gadget::tokens::BufferSampleTag);
         writer->beginAttribute(gadget::tokens::BufferSampleLenAttrib);
            writer->writeUint16(stable_buffer[j].size());                           // Write the # of DigitalDatas in the vector
         writer->endAttribute();
         for ( unsigned i=0;i<stable_buffer[j].size();i++ )                         // For each DigitalData in the vector
         {
            writer->beginTag(gadget::tokens::DigitalValue);
            writer->beginAttribute(gadget::tokens::TimeStamp);
               writer->writeUint64(stable_buffer[j][i].getTime().usec());           // Write Time Stamp vpr::Uint64
            writer->endAttribute();
            writer->writeUint32((vpr::Uint32)stable_buffer[j][i].getDigital());  // Write Digital Data(int)
            writer->endTag();
         }
         writer->endTag();
      }
      mDigitalSamples.unlock();
   }
   writer->endTag();

   return vpr::ReturnStatus::Succeed;
}

vpr::ReturnStatus gadget::Digital::readObject

(

vpr::ObjectReader *

reader

)

[virtual]

De-serializes this object.

Reimplemented in gadget::InputMixer< gadget::InputMixer< gadget::SimInput, gadget::Input >, gadget::Digital >.

Definition at line 119 of file Digital.cpp.

References gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::addSample(), gadget::tokens::BufferSampleLenAttrib(), gadget::tokens::BufferSampleTag(), gadget::tokens::DataTypeAttrib(), gadget::tokens::DigitalValue(), getInputTypeName(), gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::lock(), gadget::MSG_DATA_DIGITAL, gadget::tokens::SampleBufferLenAttrib(), gadget::DigitalData::setDigital(), gadget::InputData::setTime(), gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::swapBuffers(), gadget::tokens::TimeStamp(), and gadget::SampleBuffer< DATA_TYPE, MAX_BUFFER_SIZE >::unlock().

{
      //std::cout << "[Remote Input Manager] In Digital read" << std::endl;
   vprASSERT(reader->attribExists("rim.timestamp.delta"));
   vpr::Uint64 delta = reader->getAttrib<vpr::Uint64>("rim.timestamp.delta");

      // ASSERT if this data is really not Digital Data
   reader->beginTag(Digital::getInputTypeName());
   reader->beginAttribute(gadget::tokens::DataTypeAttrib);
      vpr::Uint16 temp = reader->readUint16();
   reader->endAttribute();

   // XXX: Should there be error checking for the case when vprASSERT()
   // is compiled out?  -PH 8/21/2003
   vprASSERT(temp==MSG_DATA_DIGITAL && "[Remote Input Manager]Not Digital Data");
   boost::ignore_unused_variable_warning(temp);

   std::vector<DigitalData> dataSample;

   unsigned numDigitalDatas;
   vpr::Uint32 value;
   vpr::Uint64 timeStamp;
   DigitalData temp_digital_data;

   reader->beginAttribute(gadget::tokens::SampleBufferLenAttrib);
      unsigned numVectors = reader->readUint16();
   reader->endAttribute();

   //std::cout << "Stable Digital Buffer Size: "  << numVectors << std::endl;
   mDigitalSamples.lock();
   for ( unsigned i=0;i<numVectors;i++ )
   {
      reader->beginTag(gadget::tokens::BufferSampleTag);
      reader->beginAttribute(gadget::tokens::BufferSampleLenAttrib);
         numDigitalDatas = reader->readUint16();
      reader->endAttribute();

      dataSample.clear();
      for ( unsigned j=0;j<numDigitalDatas;j++ )
      {
         reader->beginTag(gadget::tokens::DigitalValue);
         reader->beginAttribute(gadget::tokens::TimeStamp);
            timeStamp = reader->readUint64();    // read Time Stamp vpr::Uint64
         reader->endAttribute();
         value = reader->readUint32();           // read Digital Data(int)
         reader->endTag();

         temp_digital_data.setDigital(value);
         temp_digital_data.setTime(vpr::Interval(timeStamp + delta,vpr::Interval::Usec));
         dataSample.push_back(temp_digital_data);
      }
      mDigitalSamples.addSample(dataSample);
      reader->endTag();
   }
   mDigitalSamples.unlock();
   mDigitalSamples.swapBuffers();

   reader->endTag();

   return vpr::ReturnStatus::Succeed;
}

void gadget::Digital::operator=

(

const gadget::Digital &

)

[inline, protected]

Definition at line 165 of file Digital.h.

{;}

---

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

• Digital.h
• Digital.cpp

---