gadget::DeviceInterface< PROXY_TYPE > Class Template Reference

Type-specific device interface. More...

#include <gadget/Type/DeviceInterface.h>

Inheritance diagram for gadget::DeviceInterface< PROXY_TYPE >:

[legend]Collaboration diagram for gadget::DeviceInterface< PROXY_TYPE >:

[legend]List of all members.

Public Member Functions
	DeviceInterface (const DeviceInterface &other)
	DeviceInterface ()
PROXY_TYPE *	getProxy ()
	Returns the underlying proxy to which we are connected.
void	setProxy (PROXY_TYPE *proxy)
	Sets the proxy to an explicit proxy.
virtual void	refresh ()
	Refreshes the interface based on the current configuration.
Smart pointer operator overloads.
Device interfaces make use of the Smart Pointer design pattern. Access to the contained device proxy must occur through one of these operators.
PROXY_TYPE *	operator-> ()
	Member selection (via pointer) operator overload.
PROXY_TYPE &	operator * ()
	Dereference operator overload.

---

Detailed Description

template<class PROXY_TYPE>
class gadget::DeviceInterface< PROXY_TYPE >

Type-specific device interface.

Definition at line 145 of file DeviceInterface.h.

---

Constructor & Destructor Documentation

template<class PROXY_TYPE>

gadget::DeviceInterface< PROXY_TYPE >::DeviceInterface

(

const DeviceInterface< PROXY_TYPE > &

other

)

[inline]

Definition at line 148 of file DeviceInterface.h.

References gadget::DeviceInterface< PROXY_TYPE >::mTypeSpecificProxy.

      : BaseDeviceInterface(other)
   {
      if (other.mTypeSpecificProxy != NULL)
      {
         mTypeSpecificProxy = other.mTypeSpecificProxy;
      }
      else
      {
         mTypeSpecificProxy = &mDummyProxy;
      }
   }

template<class PROXY_TYPE>

gadget::DeviceInterface< PROXY_TYPE >::DeviceInterface

(

)

[inline]

Definition at line 162 of file DeviceInterface.h.

      : BaseDeviceInterface()
   {
      mTypeSpecificProxy = &mDummyProxy;
   }

---

Member Function Documentation

template<class PROXY_TYPE>

PROXY_TYPE* gadget::DeviceInterface< PROXY_TYPE >::operator->

(

)

[inline]

Member selection (via pointer) operator overload.

Precondition:

init() has been invoked.

See also:

init()

Definition at line 182 of file DeviceInterface.h.

   {
      return mTypeSpecificProxy;
   }

template<class PROXY_TYPE>

PROXY_TYPE& gadget::DeviceInterface< PROXY_TYPE >::operator *

(

)

[inline]

Dereference operator overload.

Precondition:

init() has been invoked.

See also:

init()

Definition at line 194 of file DeviceInterface.h.

   {
      return *(mTypeSpecificProxy);
   }

template<class PROXY_TYPE>

PROXY_TYPE* gadget::DeviceInterface< PROXY_TYPE >::getProxy

(

)

[inline]

Returns the underlying proxy to which we are connected.

Definition at line 201 of file DeviceInterface.h.

   {
      return mTypeSpecificProxy;
   }

template<class PROXY_TYPE>

void gadget::DeviceInterface< PROXY_TYPE >::setProxy

(

PROXY_TYPE *

proxy

)

[inline]

Sets the proxy to an explicit proxy.

Definition at line 207 of file DeviceInterface.h.

References gadget::BaseDeviceInterface::mNameSet, gadget::BaseDeviceInterface::mProxyName, and gadget::DeviceInterface< PROXY_TYPE >::refresh().

   {
      vprASSERT(NULL != proxy);
      mProxyName = proxy->getName();    // Set the name
      mNameSet = true;
      this->refresh();

      // Verify we found the correct proxy
      vprASSERT(mTypeSpecificProxy == proxy && "Found incorrect proxy for dev interface");
   }

template<class PROXY_TYPE>

virtual void gadget::DeviceInterface< PROXY_TYPE >::refresh

(

)

[inline, 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 from gadget::BaseDeviceInterface.

Definition at line 218 of file DeviceInterface.h.

References gadgetDBG_INPUT_MGR(), gadget::BaseDeviceInterface::mProxyName, gadget::BaseDeviceInterface::mProxyPtr, and gadget::BaseDeviceInterface::refresh().

Referenced by gadget::DeviceInterface< PROXY_TYPE >::setProxy().

   {
      BaseDeviceInterface::refresh();
      if(mProxyPtr != NULL)
      {
         mTypeSpecificProxy = dynamic_cast<PROXY_TYPE*>(mProxyPtr);
         if(NULL == mTypeSpecificProxy)
         {
            vprDEBUG(gadgetDBG_INPUT_MGR, vprDBG_CRITICAL_LVL)
               << "[gadget::DeviceInterface::refresh()] Tried to point at "
               << "proxy of incorrect type named '" << mProxyName << "'"
               << " it was type:" << typeid(mProxyPtr).name()
               << std::endl << vprDEBUG_FLUSH;
         }
      }

      // If either one of the proxy pointers are NULL, then use a dummy
      if((NULL == mProxyPtr) || (NULL == mTypeSpecificProxy))
      {
         mTypeSpecificProxy = &mDummyProxy;
      }
   }

---

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

• DeviceInterface.h

---