gadget::BaseDeviceInterface Class Reference

Base class for simplified proxy interfaces. More...

#include <gadget/Type/DeviceInterface.h>

Inheritance diagram for gadget::BaseDeviceInterface:

[legend]Collaboration diagram for gadget::BaseDeviceInterface:

[legend]List of all members.

Public Member Functions
	BaseDeviceInterface ()
virtual	~BaseDeviceInterface ()
	BaseDeviceInterface (const BaseDeviceInterface &other)
	Copy constructor.
void	init (const std::string &proxyName)
	Initializes the object.
virtual void	refresh ()
	Refreshes the interface based on the current configuration.
std::string	getProxyName () const
	Returns the name of the proxy.
bool	isConnected () const
	Identifies whether this device interface is connected to a proxy.
Static Public Member Functions
static void	refreshAllInterfaces ()
	Refreshes all the known device interface objects.
static void	refreshAllDevices ()
	Refreshes all the known device interface objects.
Protected Attributes
Proxy *	mProxyPtr
	Ptr to the proxy.
std::string	mProxyName
	The name of the proxy (or alias) we are looking at.
bool	mNameSet
	Has the user set a name??

---

Detailed Description

Base class for simplified proxy interfaces.

Device interfaces are wrappers that provide an easier way to access proxy objects from within user applications. Users can simply declare a local interface variable and use it as a smart pointer for the proxy.

Note:

The init() function should be called in the init() function of the user application.

Definition at line 65 of file DeviceInterface.h.

---

Constructor & Destructor Documentation

gadget::BaseDeviceInterface::BaseDeviceInterface

(

)

Definition at line 43 of file DeviceInterface.cpp.

   : mProxyPtr(NULL)
   , mProxyName("UnInitialized")
   , mNameSet(false)
{
   // Keep reference to the interface.
   BaseDeviceInterface::addDevInterface(this);
}

gadget::BaseDeviceInterface::~BaseDeviceInterface

(

)

[virtual]

Definition at line 52 of file DeviceInterface.cpp.

{
   // Remove it from the list of active interfaces.
   BaseDeviceInterface::removeDevInterface(this);
}

gadget::BaseDeviceInterface::BaseDeviceInterface

(

const BaseDeviceInterface &

other

)

Copy constructor.

Definition at line 59 of file DeviceInterface.cpp.

   : mProxyPtr(other.mProxyPtr)
   , mProxyName(other.mProxyName)
   , mNameSet(other.mNameSet)
{
   // Keep reference to the interface.
   BaseDeviceInterface::addDevInterface(this);
}

---

Member Function Documentation

void gadget::BaseDeviceInterface::init

(

const std::string &

proxyName

)

Initializes the object.

Parameters:

proxyName

String name of the proxy to connect to.

Definition at line 68 of file DeviceInterface.cpp.

References mNameSet, mProxyName, and refresh().

Referenced by gadget::SimRelativePosition::config(), gadget::SimInput::config(), and gadget::InputLogger::config().

{
   mProxyName = proxyName;    // Set the name
   mNameSet = true;
   refresh();                 // Refresh the name
}

void gadget::BaseDeviceInterface::refresh

(

)

[virtual]

Refreshes the interface based on the current configuration.

This method is called by refreshAllInterfaces when system

Postcondition:

(mProxyIndex == -1) ==> Proxy not initialized yet.
(mProxyIndex != -1) ==> mProxyName has name of device && local proxy pointer is set to the device.

Reimplemented in gadget::DeviceInterface< PROXY_TYPE >.

Definition at line 77 of file DeviceInterface.cpp.

References mNameSet, mProxyName, and mProxyPtr.

Referenced by init(), and gadget::DeviceInterface< PROXY_TYPE >::refresh().

{
   Proxy* prev_proxy_ptr = mProxyPtr;    // Keep track of previous value

   // If it is not initialized, then don't try
   if ( ! mNameSet )
   {
      return;
   }

   mProxyPtr = InputManager::instance()->getProxy(mProxyName);

   if (NULL == mProxyPtr)
   {
      vprDEBUG(vprDBG_ALL,vprDBG_CONFIG_LVL)
         << "WARNING: DeviceInterface::refresh: could not find proxy: "
         << mProxyName.c_str() << std::endl << vprDEBUG_FLUSH;
      vprDEBUG(vprDBG_ALL,vprDBG_CONFIG_LVL)
         << "         Make sure the proxy exists in the current configuration."
         << std::endl << vprDEBUG_FLUSH;
      vprDEBUG(vprDBG_ALL,vprDBG_CONFIG_LVL)
         << "   referencing device interface will be stupefied to point at dummy device."
         << std::endl << vprDEBUG_FLUSH;
   }
   // ASSERT: We have just gotten a valid proxy to point to
   else if((NULL != mProxyPtr) && (NULL == prev_proxy_ptr))
   {
      const int item_width(25+12);
      //const int type_width(20);

      //vprDEBUG(vprDBG_ALL,vprDBG_CONFIG_STATUS_LVL)
      //   << "DeviceInterface now able to find proxy: "
      //   << mProxyName.c_str() << "               [ "
      //   << clrSetNORM(clrGREEN) << "OK" << clrRESET << " ]"
      //   << std::endl << vprDEBUG_FLUSH;

      //std::string device_name("");
      //Input* deviceptr = mProxyPtr->getProxiedInputDevice();
      //if (NULL != deviceptr)
      //{
      //   device_name = deviceptr->getInstanceName();
      //}

      vprDEBUG(vprDBG_ALL,vprDBG_CONFIG_STATUS_LVL)
         << "DeviceInterface found proxy: "
         << std::setiosflags(std::ios::right)
         << std::setfill(' ') << std::setw(item_width) << mProxyName
         << std::resetiosflags(std::ios::right) << "  ";
      vprDEBUG_CONTnl(vprDBG_ALL,vprDBG_CONFIG_STATUS_LVL)
         << "[ " << clrSetNORM(clrGREEN) << "OK" << clrRESET << " ]";
      vprDEBUG_CONTnl(vprDBG_ALL,vprDBG_CONFIG_STATUS_LVL)
         << std::endl << vprDEBUG_FLUSH;
   }
}

std::string gadget::BaseDeviceInterface::getProxyName

(

)

const [inline]

Returns the name of the proxy.

Definition at line 93 of file DeviceInterface.h.

   {
      return mProxyName;
   }

bool gadget::BaseDeviceInterface::isConnected

(

)

const [inline]

Identifies whether this device interface is connected to a proxy.

Definition at line 99 of file DeviceInterface.h.

   {
      return (NULL != mProxyPtr);
   }

void gadget::BaseDeviceInterface::refreshAllInterfaces

(

)

[static]

Refreshes all the known device interface objects.

Since:

1.0.2

Definition at line 151 of file DeviceInterface.cpp.

Referenced by gadget::InputManager::configRemove(), and refreshAllDevices().

{
   for ( unsigned int i = 0; i < mAllocatedDevices.size(); ++i )
   {
      BaseDeviceInterface* dev = mAllocatedDevices[i];
      dev->refresh();
   }
}

void gadget::BaseDeviceInterface::refreshAllDevices

(

)

[static]

Refreshes all the known device interface objects.

Deprecated:

This method has been renamed to refreshAllInterfaces() and will be removed in Gadgeteer 1.2.

See also:

refreshAllInterfaces()

Definition at line 160 of file DeviceInterface.cpp.

References refreshAllInterfaces().

{
   vprDEBUG(vprDBG_ALL, vprDBG_WARNING_LVL)
      << clrOutBOLD(clrYELLOW, "NOTICE:")
      << " gadget::BaseDeviceInterface::refreshAllDevices() has been replaced"
      << std::endl;
   vprDEBUG_NEXTnl(vprDBG_ALL, vprDBG_WARNING_LVL)
      << "by gadget::BaseDeviceInterface::refreshAllInterfaces()."
      << std::endl << vprDEBUG_FLUSH;
   refreshAllInterfaces();
}

---

Member Data Documentation

Proxy* gadget::BaseDeviceInterface::mProxyPtr [protected]

Ptr to the proxy.

Definition at line 105 of file DeviceInterface.h.

Referenced by gadget::DeviceInterface< PROXY_TYPE >::refresh(), and refresh().

std::string gadget::BaseDeviceInterface::mProxyName [protected]

The name of the proxy (or alias) we are looking at.

Definition at line 106 of file DeviceInterface.h.

Referenced by init(), gadget::DeviceInterface< PROXY_TYPE >::refresh(), refresh(), and gadget::DeviceInterface< PROXY_TYPE >::setProxy().

bool gadget::BaseDeviceInterface::mNameSet [protected]

Has the user set a name??

Definition at line 107 of file DeviceInterface.h.

Referenced by init(), refresh(), and gadget::DeviceInterface< PROXY_TYPE >::setProxy().

---

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

• DeviceInterface.h
• DeviceInterface.cpp

---