cmil::DeviceInputs Class Reference

#include <InputDevice.h>

Inheritance diagram for cmil::DeviceInputs:

[legend]Collaboration diagram for cmil::DeviceInputs:

[legend]List of all members.

Public Types
typedef std::map< const std::string, InputData *const >	Inputs
Public Member Functions
	DeviceInputs ()
void	cleanup ()
	Cleanup the IputData memory.
void	add (const std::string &set_device_name, InputData *input)
DeviceInputs *	clone () const
void	dumpInputs () const
const Inputs &	getInputs () const
const Inputs &	getCustomInputs () const
InputData *const	getData (bool which, const std::string &name) const
std::string	getName () const
bool	isEqual (bool match_custom, const DeviceInputs &inputs) const
bool	operator== (const DeviceInputs &inputs) const
void	removeInput (const std::string &name)
unsigned long int	resetIDs (unsigned long int count)
void	resetWhichDevice (unsigned long int which_device)
bool	setInput (const std::string &old_name, const std::string &new_name)
bool	setInputs (const DeviceInputs &dev_inputs)
Static Public Attributes
static const bool	use_base = true
	These are here to reduce confusion.
static const bool	use_custom = false
Private Member Functions
	DeviceInputs (const Inputs &cloned_base, const Inputs &cloned_custom)
InputData *const	getData (const Inputs &inputs, const std::string &name) const
bool	match_inputs (const Inputs &first, const Inputs &second) const
	This is a utility function which matches on name existance and data type.
bool	erase (const std::string &name, Inputs &inputs)
	This both unallocates the inputdata and removes it from the list, use with care.
bool	remove (const std::string &name, Inputs &inputs)
bool	renameData (Inputs &inputs, const std::string &old_name, const std::string &new_name)
Private Attributes
Inputs	m_base
	Inputs are only added to this container.
Inputs	m_custom
	Inputs are customized via this container.

---

Detailed Description

Definition at line 24 of file InputDevice.h.

---

Member Typedef Documentation

typedef std::map<const std::string, InputData* const> cmil::DeviceInputs::Inputs

Definition at line 26 of file InputDevice.h.

---

Constructor & Destructor Documentation

cmil::DeviceInputs::DeviceInputs

(

)

[inline]

Definition at line 27 of file InputDevice.h.

Referenced by clone().

{};

Here is the caller graph for this function:

cmil::DeviceInputs::DeviceInputs	(	const Inputs &	cloned_base,
		const Inputs &	cloned_custom
	)			[private]

Definition at line 40 of file InputDevice.cpp.

References cmil::InputData::clone(), Logger::log_error(), m_base, and m_custom.

                                                                                   {
    InputData* input_data = NULL;

    Inputs::const_iterator i, i_custom;
    std::string custom_name;

    for(i = cloned_base.begin(); i != cloned_base.end(); ++i) {
      input_data = (*i).second->clone();

      std::pair<std::string, InputData* const> input_pair ( (*i).first, input_data ); 
      m_base.insert(input_pair); 
    }

    if(cloned_custom.size()) {
      if(cloned_custom.size() != cloned_base.size()) 
        log_error("DevceInputs(cloned_base, cloned_custom) : parameter indexes are not equal in size."); 
      else {
        i_custom = cloned_custom.begin();

        for(i = m_base.begin(); i != m_base.end(); ++i) {
          input_data = i->second;

          std::pair<std::string, InputData* const> input_pair ((*i_custom).first, input_data); 
          m_custom.insert(input_pair);  
          ++i_custom;
        }
      }
    } 
  }

Here is the call graph for this function:

---

Member Function Documentation

void cmil::DeviceInputs::add	(	const std::string &	set_device_name,
		InputData *	input
	)

Definition at line 103 of file InputDevice.cpp.

References cmil::InputData::getName(), Logger::log_error(), m_base, and cmil::InputData::setDevice().

Referenced by cmil::InputDevice::add(), and cmil::tInputIndex< T >::fill_indexes().

                                                                       {
    if(!input)
      log_error("add() passed null input");
    else {
      if( m_base.find(input->getName()) != m_base.end() )
        log_error(std::string("DeviceInputs::add() insertion of ").append(input->getName()).append( 
            "failed due to pre-existing input of the same name"));
      else {
        input->setDevice(device_name);
        std::pair<std::string, InputData* const> input_pair (input->getName(), input); 
//        log_debug(std::string("adding: ").append(input->getName()));
        m_base.insert(input_pair);  
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceInputs::cleanup

(

)

Cleanup the IputData memory.

Definition at line 72 of file InputDevice.cpp.

References Logger::log_debug(), and m_base.

Referenced by cmil::InputDevice::cleanup().

                             {
    Inputs::iterator i;
    int dcount = 0;

    for(i = m_base.begin() ; i != m_base.end() ; ++i) {
      if(i->second) {
        delete (i->second);
        dcount++;
      }
    }

    std::ostringstream debug_ss;
    debug_ss << "cleanup() deleted memory consisting of : " << dcount  << " addresses.";
    log_debug( debug_ss.str() );
  }

Here is the call graph for this function:

Here is the caller graph for this function:

DeviceInputs * cmil::DeviceInputs::clone

(

)

const

Definition at line 97 of file InputDevice.cpp.

References DeviceInputs(), Logger::log_debug(), m_base, and m_custom.

                                          {
    log_debug("clone()");
    return new DeviceInputs(m_base, m_custom);
  }

Here is the call graph for this function:

void cmil::DeviceInputs::dumpInputs

(

)

const

Definition at line 88 of file InputDevice.cpp.

References Logger::log_debug(), and m_custom.

Referenced by cmil::InputDevice::dumpInputs().

                                      {
    for( Inputs::const_iterator i = m_custom.begin(); i != m_custom.end(); ++i) 
      log_debug( std::string("Dumping custom, input name: ").append( i->first ) ); 
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool cmil::DeviceInputs::erase	(	const std::string &	name,
		Inputs &	inputs
	)			[private]

This both unallocates the inputdata and removes it from the list, use with care.

Definition at line 120 of file InputDevice.cpp.

References Logger::log_error().

Referenced by removeInput().

                                                                { 
    if(inputs.find(name) == inputs.end()) {
      log_error("remove() tried to remove non-existant input");
      return false;
    }
    else {
      delete inputs[name];
      inputs.erase(name);
    }

    return true;
  } 

Here is the call graph for this function:

Here is the caller graph for this function:

const DeviceInputs::Inputs & cmil::DeviceInputs::getCustomInputs

(

)

const

Definition at line 137 of file InputDevice.cpp.

References m_custom.

Referenced by cmil::DeviceRegistry::copyDevice(), isEqual(), and setInputs().

                                                                {
    return m_custom;
  }

Here is the caller graph for this function:

InputData *const cmil::DeviceInputs::getData	(	const Inputs &	inputs,
		const std::string &	name
	)			const [private]

Definition at line 154 of file InputDevice.cpp.

References Logger::log_error().

                                                                                          {
    Inputs::const_iterator i = inputs.find(name);

    if (i != inputs.end() ) { 
       //log_debug(std::string("getData() returning data for string: ").append(name)); 
       return i->second;
    }

    log_error(std::string("getData() returning NULL for string: ").append(name)); 

//    std::ostringstream num_ss; 
//    for(i = inputs.begin() ; i != inputs.end() ; i++)
//      log_error(std::string("getData() scanned : ").append(i->first)); 

    return NULL;
  }

Here is the call graph for this function:

InputData *const cmil::DeviceInputs::getData	(	bool	which,
		const std::string &	name
	)			const

Definition at line 171 of file InputDevice.cpp.

References m_base, and m_custom.

Referenced by cmil::InputDevice::getData().

                                                                                    {
    if(base_data || (m_custom.size() == 0)) {
      //log_debug("getData(bool, name) : calling on base");
      return getData(m_base, name);
    }

    //log_debug("getData(bool, name) : calling on custom");
    return getData(m_custom, name);
  }

Here is the caller graph for this function:

const DeviceInputs::Inputs & cmil::DeviceInputs::getInputs

(

)

const

Definition at line 133 of file InputDevice.cpp.

References m_base.

Referenced by isEqual(), cmil::Mouse::operator==(), and setInputs().

                                                          {
    return m_base;
  }

Here is the caller graph for this function:

std::string cmil::DeviceInputs::getName

(

)

const [virtual]

Implements Logger.

Definition at line 93 of file InputDevice.cpp.

                                        {
    return "DeviceInputs";
  }

bool cmil::DeviceInputs::isEqual	(	bool	match_custom,
		const DeviceInputs &	inputs
	)			const

Definition at line 193 of file InputDevice.cpp.

References getCustomInputs(), getInputs(), Logger::log_debug(), m_base, m_custom, and match_inputs().

Referenced by cmil::SDL::DefaultMouse::operator==(), operator==(), and setInputs().

                                                                                   {
    log_debug("isEqual()");
    bool is_equal = false;
    if(match_custom) 
      is_equal = match_inputs(m_custom, devinputs.getCustomInputs());
    
    is_equal = match_inputs(m_base, devinputs.getInputs());
    return is_equal;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool cmil::DeviceInputs::match_inputs	(	const Inputs &	first,
		const Inputs &	second
	)			const [private]

This is a utility function which matches on name existance and data type.

Definition at line 204 of file InputDevice.cpp.

References Logger::log_error().

Referenced by isEqual().

                                                                                 {
    Inputs::const_iterator a, b;

    if(first.size() != second.size()) 
      return false;

    for(a = first.begin() ; a != first.end(); ++a) {
      b = second.find(a->first);

      if(b == second.end()) {
        log_error( "match_inputs() returning false due to input name mismatch");
        return false;
      }
      else if ( typeid(*(a->second)) != typeid(*(b->second)) ) {
        log_error( "match_inputs() returning false due to type mismatch");
        return false;
      }
    }
      
    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool cmil::DeviceInputs::operator==

(

const DeviceInputs &

inputs

)

const

Definition at line 181 of file InputDevice.cpp.

References isEqual(), Logger::log_debug(), and Logger::log_error().

                                                                   {
    const bool match_custom = true;

    if(isEqual(match_custom, devinputs)) {
      log_debug("operator== match_inputs returning true");
      return true;
    }

    log_error("operator== match_inputs returning false");
    return false;
  }

Here is the call graph for this function:

bool cmil::DeviceInputs::remove	(	const std::string &	name,
		Inputs &	inputs
	)			[private]

Definition at line 142 of file InputDevice.cpp.

References Logger::log_debug().

Referenced by removeInput().

                                                                 {
    if(inputs.find(name) == inputs.end()) {
      log_debug("remove() Tried to remove non-existant input.");
      return false;
    }
    else {
      inputs.erase(name);
    }

    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceInputs::removeInput

(

const std::string &

name

)

Definition at line 226 of file InputDevice.cpp.

References erase(), m_base, m_custom, and remove().

Referenced by cmil::InputDevice::removeInput().

                                                      {
    if(m_custom.size())
     remove(name, m_custom);
   erase(name, m_base);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool cmil::DeviceInputs::renameData	(	Inputs &	inputs,
		const std::string &	old_name,
		const std::string &	new_name
	)			[private]

Definition at line 276 of file InputDevice.cpp.

References Logger::log_debug(), and Logger::log_error().

Referenced by setInput().

                                                                                                    {
    InputData* tmp_ptr = NULL;  
    Inputs::iterator i; 

    if( inputs.find(new_name) != inputs.end() ) {
      //log_error("renameData() tried to set name to pre-existing input"); 
      return false;
    }
    else if( ( (i = inputs.find(old_name)) == inputs.end()) ) {
      log_error("renameData() input to be renamed doesn't exist"); 
      return false;
    }
    else if(!(tmp_ptr= inputs[old_name])) {
      log_error("renameData() InputData found null at old_name"); 
      return false;
    }

    log_debug(std::string("setting data old name: ").append(old_name).append(" to: ").append(new_name));

    tmp_ptr -> setName(new_name);

    inputs.erase(inputs.find(old_name));

    std::pair<std::string, InputData* const> input_pair (new_name, tmp_ptr); 
    inputs.insert(input_pair);

    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned long int cmil::DeviceInputs::resetIDs

(

unsigned long int

count

)

Definition at line 261 of file InputDevice.cpp.

References Logger::log_debug(), and m_base.

Referenced by cmil::InputDevice::resetIDs().

                                                                    {
    log_debug("resetting base IDs");
    Inputs::iterator i;
    for(i = m_base.begin(); i != m_base.end(); ++i)  
      (i->second)->setID(count++);

    return count;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void cmil::DeviceInputs::resetWhichDevice

(

unsigned long int

which_device

)

Definition at line 270 of file InputDevice.cpp.

References m_base.

Referenced by cmil::InputDevice::resetWhichDevice().

                                                                     {
    Inputs::iterator i;
    for(i = m_base.begin(); i != m_base.end(); ++i) 
      (i->second)->setWhichDevice(which_device);
  }

Here is the caller graph for this function:

bool cmil::DeviceInputs::setInput	(	const std::string &	old_name,
		const std::string &	new_name
	)

Definition at line 308 of file InputDevice.cpp.

References m_base, m_custom, and renameData().

Referenced by cmil::InputDevice::setInput(), and setInputs().

                                                                                  {
    if(!m_custom.size())
      m_custom = m_base;

    if( renameData(m_custom, old_name, new_name) )
      return true;

    //log_error("setInput() failed to rename input");
    return false;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool cmil::DeviceInputs::setInputs

(

const DeviceInputs &

dev_inputs

)

Definition at line 232 of file InputDevice.cpp.

References getCustomInputs(), getInputs(), isEqual(), Logger::log_error(), m_custom, and setInput().

Referenced by cmil::InputDevice::setInputs().

                                                             {
    const bool match_base = false;
    std::string base_name, custom_name;
    Inputs::const_iterator i, i_custom;

    if( !(isEqual(match_base, dev_inputs)) ) {
      log_error("setInputs() This operation isn't allowed due to DeviceInputs base mismatch"); 
      return false;
    }
    else {
      if(dev_inputs.getInputs().size() != dev_inputs.getCustomInputs().size()) {
        log_error("setInputs() This operation isn't allowed due to a mismatch in size of parameter inputs."); 
        return false;
      }
    }

    m_custom.clear(); 

    
    for(i = dev_inputs.getInputs().begin(); i != dev_inputs.getInputs().end(); ++i) 
      setInput(i->first, i->second->getName());

    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

Inputs cmil::DeviceInputs::m_base [private]

Inputs are only added to this container.

Definition at line 76 of file InputDevice.h.

Referenced by add(), cleanup(), clone(), DeviceInputs(), getData(), getInputs(), isEqual(), removeInput(), resetIDs(), resetWhichDevice(), and setInput().

Inputs cmil::DeviceInputs::m_custom [private]

Inputs are customized via this container.

Definition at line 79 of file InputDevice.h.

Referenced by clone(), DeviceInputs(), dumpInputs(), getCustomInputs(), getData(), isEqual(), removeInput(), setInput(), and setInputs().

const bool cmil::DeviceInputs::use_base = true [static]

These are here to reduce confusion.

Definition at line 41 of file InputDevice.h.

Referenced by cmil::SDL::SDLMice::assign_inputs(), and cmil::InputDevice::getData().

const bool cmil::DeviceInputs::use_custom = false [static]

Definition at line 42 of file InputDevice.h.

Referenced by cmil::DeviceRegistry::getData().

---

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

---