Medical Imaging Interaction Toolkit  2018.4.99-3e3f1a6e
Medical Imaging Interaction Toolkit
mitk::KinectDeviceFactory Class Reference

KinectDeviceFactory is an implementation of the factory pattern to generate Microsoft Kinect devices. KinectDeviceFactory inherits from AbstractToFDeviceFactory which is a MicroService interface. This offers users the oppertunity to generate new KinectDevices via a global instance of this factory. More...

#include <mitkKinectDeviceFactory.h>

Inheritance diagram for mitk::KinectDeviceFactory:
Collaboration diagram for mitk::KinectDeviceFactory:

Public Member Functions

 KinectDeviceFactory ()
 KinectDeviceFactory Default contructor. This factory internally counts all kinect devices starting at 1. More...
 
std::string GetFactoryName ()
 Get the name of the factory, here for the Kinect. More...
 
std::string GetDeviceNamePrefix ()
 GetDeviceNamePrefix Main part of a device name. More...
 
- Public Member Functions inherited from mitk::AbstractToFDeviceFactory
ToFCameraDevice::Pointer ConnectToFDevice ()
 ConnectToFDevice Use this method to connect a device. More...
 
void DisconnectToFDevice (const ToFCameraDevice::Pointer &device)
 DisconnectToFDevice Use this method to disconnect a device. More...
 
vcl_size_t GetNumberOfDevices ()
 GetNumberOfDevices Get the number of devices produced by this factory. This function will return the number of registered devices to account for created and disconnected devices. More...
 
std::string GetCurrentDeviceName () override
 GetCurrentDeviceName Get the human readable name of the current device. A factory can produce many device and give ordered names for each device (e.g. number them like Device_1, Device_2, etc.). More...
 
- Public Member Functions inherited from mitk::IToFDeviceFactory
virtual ~IToFDeviceFactory ()
 

Additional Inherited Members

- Protected Member Functions inherited from mitk::AbstractToFDeviceFactory
CameraIntrinsics::Pointer GetCameraIntrinsics ()
 Returns the CameraIntrinsics for the cameras created by this factory. More...
 
- Protected Attributes inherited from mitk::AbstractToFDeviceFactory
std::vector< ToFCameraDevice::Pointer > m_Devices
 m_Devices A list (vector) containing all connected devices of the respective factory. More...
 
std::map< ToFCameraDevice *, us::ServiceRegistration< ToFCameraDevice > > m_DeviceRegistrations
 m_DeviceRegistrations A map containing all the pairs of device registration numbers and devices. More...
 

Detailed Description

KinectDeviceFactory is an implementation of the factory pattern to generate Microsoft Kinect devices. KinectDeviceFactory inherits from AbstractToFDeviceFactory which is a MicroService interface. This offers users the oppertunity to generate new KinectDevices via a global instance of this factory.

Definition at line 37 of file mitkKinectDeviceFactory.h.

Constructor & Destructor Documentation

◆ KinectDeviceFactory()

mitk::KinectDeviceFactory::KinectDeviceFactory ( )
inline

KinectDeviceFactory Default contructor. This factory internally counts all kinect devices starting at 1.

Definition at line 45 of file mitkKinectDeviceFactory.h.

Member Function Documentation

◆ GetDeviceNamePrefix()

std::string mitk::KinectDeviceFactory::GetDeviceNamePrefix ( )
inlinevirtual

GetDeviceNamePrefix Main part of a device name.

Implements mitk::IToFDeviceFactory.

Definition at line 59 of file mitkKinectDeviceFactory.h.

References ModuleContext::GetModule(), us::GetModuleContext(), us::Module::GetResource(), and mitk::KinectDevice::New().

◆ GetFactoryName()

std::string mitk::KinectDeviceFactory::GetFactoryName ( )
inlinevirtual

Get the name of the factory, here for the Kinect.

Implements mitk::IToFDeviceFactory.

Definition at line 51 of file mitkKinectDeviceFactory.h.


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