cmil::DeviceRegistry Class Reference

#include <InputDevice.h>

Inheritance diagram for cmil::DeviceRegistry:

[legend]Collaboration diagram for cmil::DeviceRegistry:

[legend]List of all members.

Public Types
typedef std::vector< InputDevice >	DeviceMultiple
	This type defines the structure of the registry.
typedef std::map< const std::string, DeviceMultiple >	DeviceIndex
	This type defines the structure of the registry.
Public Member Functions
	DeviceRegistry ()
void	cleanup ()
	This unallocates memory.
void	clear ()
virtual	~DeviceRegistry ()
virtual std::string	getName () const
void	registerDevice (InputDevice &dev)
	This function should "copy" the device into the registry.
void	mergeRegistry (DeviceRegistry &reg)
	This registers each device from the passed registry to this one.
void	SetInputIDs (InputDevice &dev)
int	getSize () const
std::string	getDefaultDevice () const
InputData *const	getData (unsigned int id) const
InputData *const	getData (const Ev &event) const
int	getID (const Ev &event) const
void	integrityCheck () const
Private Member Functions
void	copyDevice (InputDevice &dev)
Private Attributes
DeviceIndex	m_index
std::string	m_default_device
std::vector< InputData * >	m_inputs
	This is used for fast access of the InputData associated with an ID.

---

Detailed Description

This is the base DeviceRegistry which provides functions for storage of devices and their inputs.

Definition at line 197 of file InputDevice.h.

---

Member Typedef Documentation

typedef std::map<const std::string, DeviceMultiple> cmil::DeviceRegistry::DeviceIndex

This type defines the structure of the registry.

Definition at line 202 of file InputDevice.h.

typedef std::vector<InputDevice > cmil::DeviceRegistry::DeviceMultiple

This type defines the structure of the registry.

Definition at line 200 of file InputDevice.h.

---

Constructor & Destructor Documentation

cmil::DeviceRegistry::DeviceRegistry

(

)

[inline]

Definition at line 204 of file InputDevice.h.

{}

virtual cmil::DeviceRegistry::~DeviceRegistry

(

)

[inline, virtual]

Definition at line 209 of file InputDevice.h.

{}; 

---

Member Function Documentation

void cmil::DeviceRegistry::cleanup

(

)

This unallocates memory.

Definition at line 464 of file InputDevice.cpp.

References getSize(), Logger::log_debug(), and m_index.

Referenced by cmil::InputArbitrator::~InputArbitrator().

                               {
    log_debug("cleanup()");
    std::cout << "registry size: " << getSize() << std::endl;
    DeviceIndex::iterator di_iter;
    DeviceMultiple::iterator dm_iter;
    for(di_iter = m_index.begin() ; di_iter != m_index.end() ; ++di_iter) 
      for(dm_iter = di_iter->second.begin() ; dm_iter != di_iter->second.end() ; ++dm_iter) { 
        log_debug("calling dm_iter->cleanup()");
        dm_iter->cleanup();
      }
  };

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceRegistry::clear

(

)

This clears the device registry. Care with this must be taken because the memory (InputData) left by the devices will remains allocated.

Definition at line 453 of file InputDevice.cpp.

References getSize(), Logger::log_debug(), and m_index.

Referenced by cmil::SDL::SDLControllers::getDevices(), cmil::SDL::SDLMice::getDevices(), and cmil::SDL::SDLKeyboards::getDevices().

                             {
    log_debug("cleanup()");
    std::cout << "registry size: " << getSize() << std::endl;
    DeviceIndex::iterator di_iter;
    DeviceMultiple::iterator dm_iter;
    for(di_iter = m_index.begin() ; di_iter != m_index.end() ; ++di_iter) 
      di_iter->second.clear();
    m_index.clear();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceRegistry::copyDevice

(

InputDevice &

dev

)

[private]

Definition at line 577 of file InputDevice.cpp.

References cmil::DeviceInputs::getCustomInputs(), cmil::InputDevice::getInputs(), cmil::InputDevice::getName(), Logger::log_debug(), m_index, m_inputs, cmil::InputDevice::resetIDs(), and cmil::InputDevice::resetWhichDevice().

Referenced by registerDevice().

                                                   {
     DeviceInputs::Inputs::const_iterator i;
     int which_device;

     log_debug("copyDevice(): copying device");
     m_index[dev.getName()].push_back(dev);

     which_device = m_index[dev.getName()].size();

     //TODO Reverse lookup features should probably be decoupled from the InputData type instead, but this makes things fast. 

     dev.resetIDs(m_inputs.size());
     dev.resetWhichDevice(which_device);

     for(i = dev.getInputs().getCustomInputs().begin(); i != dev.getInputs().getCustomInputs().end(); ++i) 
       m_inputs.push_back(i->second); 

   }

Here is the call graph for this function:

Here is the caller graph for this function:

InputData *const cmil::DeviceRegistry::getData

(

const Ev &

event

)

const

Definition at line 488 of file InputDevice.cpp.

References getDefaultDevice(), cmil::Ev::getDeviceMultiple(), cmil::Ev::getDeviceName(), cmil::Ev::getName(), Logger::log_debug(), Logger::log_error(), m_index, and cmil::DeviceInputs::use_custom.

                                                                 {
    std::string name; 

    if((name = event.getDeviceName()) == "") {
      name = getDefaultDevice(); 
      log_debug(std::string("getData() setting name to default: ").append(name));
    }
    if(name == "")
      log_error("getData() returning null since no default device is available.");
    else {
      log_debug(std::string("getData() for device name: ").append(name));


      DeviceIndex::const_iterator i = m_index.find(name); 

      std::ostringstream size_ss;

      if(i != m_index.end()) 
        if(i->second.size() >= event.getDeviceMultiple()) {
          size_ss << "getData() number of devices with name: " << i->second.size();
          log_debug(size_ss.str());

          return i->second[event.getDeviceMultiple()].getData(DeviceInputs::use_custom, event.getName());
        }
    }

    log_error("getData() returning null");
    return NULL;
  };

Here is the call graph for this function:

InputData *const cmil::DeviceRegistry::getData

(

unsigned int

id

)

const

Definition at line 480 of file InputDevice.cpp.

References Logger::log_error(), and m_inputs.

Referenced by cmil::InputArbitrator::getData(), and getID().

                                                                {
    if(id <= m_inputs.size())
      return m_inputs[id];

    log_error("getData(id) bounds error, returnning NULL");
    return NULL;
  };

Here is the call graph for this function:

Here is the caller graph for this function:

std::string cmil::DeviceRegistry::getDefaultDevice

(

)

const

Definition at line 476 of file InputDevice.cpp.

References m_default_device.

Referenced by getData(), and cmil::InputArbitrator::getDefaultDevice().

                                                   {
    return m_default_device;
  };

Here is the caller graph for this function:

int cmil::DeviceRegistry::getID

(

const Ev &

event

)

const

In addition to returning and ID, this is used to validate an events structure via deference to getData (return 0 on error)

Definition at line 520 of file InputDevice.cpp.

References getData(), cmil::InputData::getID(), Logger::log_debug(), and Logger::log_error().

Referenced by cmil::InputArbitrator::getID().

                                                 {
    if(getData(event)) {
      log_debug("getID() found data matching event, returning id");
      return getData(event)->getID();
    }
    else {
      log_error("getID() no id found in registry which matched id");
      return 0;
    }
  };

Here is the call graph for this function:

Here is the caller graph for this function:

virtual std::string cmil::DeviceRegistry::getName

(

)

const [inline, virtual]

Implements Logger.

Definition at line 211 of file InputDevice.h.

                                        {
        return "DeviceRegistry";
      }; 

int cmil::DeviceRegistry::getSize

(

)

const

Definition at line 531 of file InputDevice.cpp.

References m_inputs.

Referenced by cleanup(), clear(), cmil::SDL::SDLControllers::getDevices(), cmil::SDL::SDLMice::getDevices(), cmil::SDL::SDLKeyboards::getDevices(), and cmil::InputArbitrator::getSize().

                                    {
     return m_inputs.size();
  };

Here is the caller graph for this function:

void cmil::DeviceRegistry::integrityCheck

(

)

const

void cmil::DeviceRegistry::mergeRegistry

(

DeviceRegistry &

reg

)

This registers each device from the passed registry to this one.

Definition at line 536 of file InputDevice.cpp.

References Logger::log_debug(), m_index, and registerDevice().

Referenced by cmil::SDL::SDLTranslator::addTranslated(), and cmil::InputArbitrator::registerDevices().

                                                        {
    log_debug("mergeRegistery() ");
    for(DeviceIndex::iterator di_iter = reg.m_index.begin() ; di_iter != reg.m_index.end() ; ++di_iter) 
      for(DeviceMultiple::iterator dm_iter = di_iter->second.begin() ; dm_iter != di_iter->second.end() ; ++dm_iter) {
        registerDevice(*dm_iter);
        log_debug(std::string("mergeRegistery() calling registerDevice() with name: ").append((*dm_iter).getName()));
      }
  };

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceRegistry::registerDevice

(

InputDevice &

dev

)

This function should "copy" the device into the registry.

First match the device by name.

None found, add this as a new device, even if their members match some other device, derive/change if you would like different behavior.

Set the first added device as the default device name.

Matched, now ensure a match using the InputDevice::operator==

Definition at line 546 of file InputDevice.cpp.

References copyDevice(), cmil::InputDevice::getName(), Logger::log_debug(), Logger::log_error(), m_default_device, and m_index.

Referenced by cmil::SDL::SDLControllers::getDevices(), cmil::SDL::SDLMice::getDevices(), cmil::SDL::SDLKeyboards::getDevices(), mergeRegistry(), and cmil::InputArbitrator::registerDevice().

                                                       {
     DeviceIndex::iterator i;

     if( (i=m_index.find(dev.getName())) == m_index.end())  {

       log_debug(std::string("registerDevice() adding device named: ").append(dev.getName()));

       if(m_index.empty()) {
         log_debug(std::string("registerDevice() setting default device to: ").append(dev.getName()));
         m_default_device = dev.getName();
       }
       copyDevice(dev); 
     }
     else {
       if ( *(i->second.begin()) == dev) {
         log_debug(std::string("registerDevices() registering another device of the same type and name: ").append(dev.getName()));
        
         copyDevice(dev); 
       }
       else {
         log_error(std::string("registerDevices() not adding device of the same name and type: ").append(dev.getName()).
           append("due to member unequality."));
       }
     }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceRegistry::SetInputIDs

(

InputDevice &

dev

)

---

Member Data Documentation

std::string cmil::DeviceRegistry::m_default_device [private]

Definition at line 237 of file InputDevice.h.

Referenced by getDefaultDevice(), and registerDevice().

DeviceIndex cmil::DeviceRegistry::m_index [private]

Definition at line 235 of file InputDevice.h.

Referenced by cleanup(), clear(), copyDevice(), getData(), mergeRegistry(), and registerDevice().

std::vector<InputData* > cmil::DeviceRegistry::m_inputs [private]

This is used for fast access of the InputData associated with an ID.

Definition at line 240 of file InputDevice.h.

Referenced by copyDevice(), getData(), and getSize().

---

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

• /home/jpf/code/cc/project/cmil/include/InputDevice.h
• /home/jpf/code/cc/project/cmil/src/InputDevice.cpp

---