gadget::CommandProxy Class Reference

A proxy class to command-oriented devices, used by the Input Manager. More...

#include <gadget/Type/CommandProxy.h>

Inheritance diagram for gadget::CommandProxy:

[legend]Collaboration diagram for gadget::CommandProxy:

[legend]List of all members.

Public Member Functions
virtual void	updateData ()
virtual vpr::Interval	getTimeStamp () const
	Returns the time of the last update.
int	getData () const
	Gets the command data.
CommandData *	getCommandData ()
Command *	getCommandPtr ()
	Returns a pointer to the gadget::Command object that we are proxying.
int	getUnit () const
	Returns the unit index into the string speech recognition device from which this proxy is reading data.
bool	config (jccl::ConfigElementPtr element)
	Configures the proxy.
virtual Input *	getProxiedInputDevice ()
	Returns a pointer to the base class of the devices being proxied.
Static Public Member Functions
static std::string	getElementType ()
	Returns the string rep of the element type used to config this device.

---

Detailed Description

A proxy class to command-oriented devices, used by the Input Manager.

A command proxy always points to a command-oriented device and unit number within that device. The Input Manager can therefore keep an array of these around and treat them as command devices that only return a single sub-device's amount of data (one int).

See also:

gagdet::Command

Definition at line 55 of file CommandProxy.h.

---

Constructor & Destructor Documentation

gadget::CommandProxy::CommandProxy

(

)

[inline]

Definition at line 61 of file CommandProxy.h.

      : mUnitNum(-1), mData(0)
   {;}

virtual gadget::CommandProxy::~CommandProxy

(

)

[inline, virtual]

Definition at line 65 of file CommandProxy.h.

   {;}

gadget::CommandProxy::CommandProxy

(

)

[inline]

Definition at line 61 of file CommandProxy.h.

      : mUnitNum(-1), mData(0)
   {;}

virtual gadget::CommandProxy::~CommandProxy

(

)

[inline, virtual]

Definition at line 65 of file CommandProxy.h.

   {;}

---

Member Function Documentation

void gadget::CommandProxy::updateData

(

)

[virtual]

Reimplemented from gadget::Proxy.

Definition at line 66 of file CommandProxy.cpp.

References getProxiedInputDevice(), gadget::Proxy::isStupefied(), gadget::TypedProxy< DEV_TYPE >::mTypedDevice, and gadget::Input::updateDataIfNeeded().

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

virtual vpr::Interval gadget::CommandProxy::getTimeStamp

(

)

const [inline, virtual]

Returns the time of the last update.

Implements gadget::Proxy.

Definition at line 72 of file CommandProxy.h.

   {
      return mData.getTime();
   }

int gadget::CommandProxy::getData

(

)

const [inline]

Gets the command data.

Definition at line 80 of file CommandProxy.h.

   {
      // If we're stupefied, return 0, return the current command value.
      return (isStupefied() ? 0 : mData.getDigital());
   }

CommandData* gadget::CommandProxy::getCommandData

(

)

[inline]

Definition at line 86 of file CommandProxy.h.

   {
      return &mData;
   }

Command* gadget::CommandProxy::getCommandPtr

(

)

[inline]

Returns a pointer to the gadget::Command object that we are proxying.

Definition at line 94 of file CommandProxy.h.

   {
      // If we're stupefied, return NULL.  Otherwise, return mTypedDevice.
      return (isStupefied() ? NULL : mTypedDevice);
   }

int gadget::CommandProxy::getUnit

(

)

const [inline]

Returns the unit index into the string speech recognition device from which this proxy is reading data.

Definition at line 104 of file CommandProxy.h.

   {
      return mUnitNum;
   }

std::string gadget::CommandProxy::getElementType

(

)

[static]

Returns the string rep of the element type used to config this device.

Used by the Input Manager to find elements that construct devices.

Reimplemented from gadget::Proxy.

Definition at line 41 of file CommandProxy.cpp.

Referenced by config().

{
   return "command_proxy";
}

bool gadget::CommandProxy::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Configures the proxy.

Postcondition:

Proxy is configured (it is not registered yet though).

Returns:

success.

Reimplemented from gadget::Proxy.

Definition at line 46 of file CommandProxy.cpp.

References gadget::Proxy::config(), gadgetDBG_INPUT_MGR(), getElementType(), gadget::TypedProxy< DEV_TYPE >::mDeviceName, and gadget::TypedProxy< DEV_TYPE >::refresh().

{
vpr::DebugOutputGuard dbg_output(gadgetDBG_INPUT_MGR, vprDBG_STATE_LVL,
                              std::string("----------- configuring COMMAND PROXY -----------------\n"),
                              std::string("----------- exit: configuring command proxy -----------\n"));

   vprASSERT(element->getID() == getElementType());

   if( ! Proxy::config(element) )
   {
      return false;
   }

   mUnitNum = element->getProperty<int>("unit");
   mDeviceName = element->getProperty<std::string>("device");

   refresh();
   return true;
}

virtual Input* gadget::CommandProxy::getProxiedInputDevice

(

)

[inline, virtual]

Returns a pointer to the base class of the devices being proxied.

Returns:

NULL if no device is proxied.

Implements gadget::Proxy.

Definition at line 113 of file CommandProxy.h.

Referenced by updateData().

   {
      if((NULL == mTypedDevice) || (mStupefied))
      {
         return NULL;
      }

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

---

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

• CommandProxy.h
• CommandProxy.cpp

---