mitk::IInputDeviceDescriptor Struct Reference [org.mitk.core.ext Plugin]

#include <mitkIInputDeviceDescriptor.h>

Inheritance diagram for mitk::IInputDeviceDescriptor:

Collaboration diagram for mitk::IInputDeviceDescriptor:

List of all members.

Public Member Functions
	berryInterfaceMacro (IInputDeviceDescriptor, mitk)
virtual IInputDevice::Pointer	CreateInputDevice ()=0
virtual std::string	GetDescription () const =0
virtual std::string	GetID () const =0
virtual std::string	GetName () const =0
virtual bool	operator== (const Object *object) const =0

---

Detailed Description

This is an input device descriptor. It provides a "description" of a given input device, so that the input device can later be constructed and registered.

The input device registry provides facilities to map from an extension to a IInputDeviceDescriptor.

This interface is not intended to be implemented by clients.

See also:

mitk::IInputDeviceRegistry

Definition at line 45 of file mitkIInputDeviceDescriptor.h.

---

Member Function Documentation

mitk::IInputDeviceDescriptor::berryInterfaceMacro	(	IInputDeviceDescriptor	,
		mitk
	)

virtual IInputDevice::Pointer mitk::IInputDeviceDescriptor::CreateInputDevice

(

)

[pure virtual]

Creates an instance of an input device defined in the descriptor.

Returns:

the input device

Implemented in mitk::InputDeviceDescriptor.

virtual std::string mitk::IInputDeviceDescriptor::GetDescription

(

)

const [pure virtual]

Returns the description of this input device.

Returns:

the description

Implemented in mitk::InputDeviceDescriptor.

virtual std::string mitk::IInputDeviceDescriptor::GetID

(

)

const [pure virtual]

Returns the id of this input device.

Returns:

the id

Implemented in mitk::InputDeviceDescriptor.

virtual std::string mitk::IInputDeviceDescriptor::GetName

(

)

const [pure virtual]

Returns the name of this input device.

Returns:

the name

Implemented in mitk::InputDeviceDescriptor.

virtual bool mitk::IInputDeviceDescriptor::operator==

(

const Object *

object )

const [pure virtual]

Returns the descriptor for the icon to show for this view. Equals this class with the given parameter.

Parameters:

object

the object for the equation

Returns:

true, if the objects are equal :: false, if they differ in any way

Implemented in mitk::InputDeviceDescriptor.

---

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

• mitkIInputDeviceDescriptor.h