mitk::InputDeviceDescriptor Class Reference [org.mitk.core.ext Plugin]

#include <mitkInputDeviceDescriptor.h>

Inheritance diagram for mitk::InputDeviceDescriptor:

Collaboration diagram for mitk::InputDeviceDescriptor:

List of all members.

Public Member Functions
	InputDeviceDescriptor (berry::IConfigurationElement::Pointer inputDeviceExtensionPoint)
	~InputDeviceDescriptor ()
mitk::IInputDevice::Pointer	CreateInputDevice ()
std::string	GetDescription () const
std::string	GetID () const
std::string	GetName () const
bool	operator== (const Object *object) const

---

Detailed Description

Documentation in the interface.

See also:

mitk::IInputDeviceDescriptor

Definition at line 36 of file mitkInputDeviceDescriptor.h.

---

Constructor & Destructor Documentation

mitk::InputDeviceDescriptor::InputDeviceDescriptor

(

berry::IConfigurationElement::Pointer

inputDeviceExtensionPoint )

Initialize the Input Device Descriptor with the given extension point.

Parameters:

inputDeviceExtensionPoint

element, that refers to a extension point (type, id, name, class)

Definition at line 22 of file mitkInputDeviceDescriptor.cpp.

: IInputDeviceDescriptor(), m_InputDeviceExtensionPoint(inputDeviceExtensionPoint)
{
}

mitk::InputDeviceDescriptor::~InputDeviceDescriptor

(

)

Default destructor

Definition at line 27 of file mitkInputDeviceDescriptor.cpp.

{
}

---

Member Function Documentation

mitk::IInputDevice::Pointer mitk::InputDeviceDescriptor::CreateInputDevice

(

)

[virtual]

See also:

mitk::IInputDeviceDescriptor::CreateInputDevice()

Implements mitk::IInputDeviceDescriptor.

Definition at line 31 of file mitkInputDeviceDescriptor.cpp.

References mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_CLASS.

{
  if(this->m_InputDevice == 0)
  {
    // "class" refers to xml attribute in a xml tag
    this->m_InputDevice = this->m_InputDeviceExtensionPoint
      ->CreateExecutableExtension<mitk::IInputDevice>(mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_CLASS);
  }
  return this->m_InputDevice;
}

std::string mitk::InputDeviceDescriptor::GetDescription

(

void

)

const [virtual]

See also:

mitk::IInputDeviceDescriptor::GetDescription()

Implements mitk::IInputDeviceDescriptor.

Definition at line 49 of file mitkInputDeviceDescriptor.cpp.

References mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_DESCRIPTION.

{
  std::vector<berry::IConfigurationElement::Pointer> 
    descriptions(this->m_InputDeviceExtensionPoint->GetChildren(mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_DESCRIPTION));

  if(!descriptions.empty())
  {
    return descriptions[0]->GetValue();
  }
  return "";
}

std::string mitk::InputDeviceDescriptor::GetID

(

)

const [virtual]

See also:

mitk::IInputDeviceDescriptor::GetID()

Implements mitk::IInputDeviceDescriptor.

Definition at line 42 of file mitkInputDeviceDescriptor.cpp.

References mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_ID.

{
  std::string idOfExtensionPoint;
  this->m_InputDeviceExtensionPoint->GetAttribute(mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_ID,idOfExtensionPoint);
  return idOfExtensionPoint;
}

std::string mitk::InputDeviceDescriptor::GetName

(

)

const [virtual]

See also:

mitk::IInputDeviceDescriptor::GetName()

Implements mitk::IInputDeviceDescriptor.

Definition at line 61 of file mitkInputDeviceDescriptor.cpp.

References mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_NAME.

{
  std::string name;
  this->m_InputDeviceExtensionPoint->GetAttribute(mitk::CoreExtConstants::INPUTDEVICE_XMLATTRIBUTE_NAME,name);
  return name;
}

bool mitk::InputDeviceDescriptor::operator==

(

const Object *

object )

const [virtual]

See also:

mitk::IInputDeviceDescriptor::operator==(const Object* object)

Implements mitk::IInputDeviceDescriptor.

Definition at line 68 of file mitkInputDeviceDescriptor.cpp.

{
  if (const InputDeviceDescriptor* other = dynamic_cast<const InputDeviceDescriptor*>(object))
  {
    return this->GetID() == other->GetID();
  }
  return false;
}

---

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

• mitkInputDeviceDescriptor.h
• mitkInputDeviceDescriptor.cpp