gadget::AnalogProxy Class Reference

A proxy class to analog devices, used by the Input Manager. More...

#include <gadget/Type/AnalogProxy.h>

Inheritance diagram for gadget::AnalogProxy:

[legend]Collaboration diagram for gadget::AnalogProxy:

[legend]List of all members.

Public Member Functions
	AnalogProxy ()
	Constructor.
virtual	~AnalogProxy ()
virtual void	updateData ()
	Updates the cached data copy from the device.
virtual vpr::Interval	getTimeStamp () const
	Returns the time of last update.
float	getData () const
	Gets the current analog data value.
Analog *	getAnalogPtr ()
	Returns a pointer to the gadget::Analog object that we are proxying.
int	getUnit () const
	Returns the unit index into the analog 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 analog devices, used by the Input Manager.

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

See also:

Analog

Definition at line 61 of file AnalogProxy.h.

---

Constructor & Destructor Documentation

gadget::AnalogProxy::AnalogProxy

(

)

[inline]

Constructor.

Definition at line 66 of file AnalogProxy.h.

      : mUnitNum(-1)
      , mData(-1.0f)
   {;}

virtual gadget::AnalogProxy::~AnalogProxy

(

)

[inline, virtual]

Definition at line 71 of file AnalogProxy.h.

   {;}

---

Member Function Documentation

virtual void gadget::AnalogProxy::updateData

(

)

[inline, virtual]

Updates the cached data copy from the device.

Reimplemented from gadget::Proxy.

Definition at line 75 of file AnalogProxy.h.

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

virtual vpr::Interval gadget::AnalogProxy::getTimeStamp

(

)

const [inline, virtual]

Returns the time of last update.

Implements gadget::Proxy.

Definition at line 86 of file AnalogProxy.h.

   {
      return mData.getTime();
   }

float gadget::AnalogProxy::getData

(

)

const [inline]

Gets the current analog data value.

Returns:

The analog data from the device.

Definition at line 95 of file AnalogProxy.h.

   {
      const float analogDefault(0.0f);
      if(isStupefied())
      {
         return analogDefault;
      }
      else
      {
         return mData.getAnalog();
      }
   }

Analog* gadget::AnalogProxy::getAnalogPtr

(

)

[inline]

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

Definition at line 109 of file AnalogProxy.h.

   {
      if(isStupefied())
      {
         return NULL;
      }
      else
      {
         return mTypedDevice;
      }
   }

int gadget::AnalogProxy::getUnit

(

)

const [inline]

Returns the unit index into the analog device from which this proxy is reading data.

Definition at line 125 of file AnalogProxy.h.

   {
      return mUnitNum;
   }

std::string gadget::AnalogProxy::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 AnalogProxy.cpp.

Referenced by gadget::ProxyDepChecker::canHandle(), and config().

{
   return "analog_proxy";
}

bool gadget::AnalogProxy::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 AnalogProxy.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 ANALOG PROXY -----------------\n"),
                                 std::string("----------- exit: configuring analog proxy -----------\n"));
   vprASSERT(element->getID() == getElementType());

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

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

   refresh();     // Refresh the device now that we have something to point at

   return true;
}

virtual Input* gadget::AnalogProxy::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 134 of file AnalogProxy.h.

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

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

---

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

• AnalogProxy.h
• AnalogProxy.cpp

---