Medical Imaging Interaction Toolkit  2021.02.99-b9f34b51
Medical Imaging Interaction Toolkit
mitk::KinectV2DeviceFactory Class Reference

KinectDeviceFactory is an implementation of the factory pattern to generate Microsoft Kinect V2 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 <mitkKinectV2DeviceFactory.h>

Inheritance diagram for mitk::KinectV2DeviceFactory:
Collaboration diagram for mitk::KinectV2DeviceFactory:

Public Member Functions

 KinectV2DeviceFactory ()
 
std::string GetFactoryName ()
 GetFactoryName Get the name of the factory. 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 V2 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 mitkKinectV2DeviceFactory.h.

Constructor & Destructor Documentation

◆ KinectV2DeviceFactory()

mitk::KinectV2DeviceFactory::KinectV2DeviceFactory ( )
inline

Definition at line 41 of file mitkKinectV2DeviceFactory.h.

Member Function Documentation

◆ GetDeviceNamePrefix()

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

GetDeviceNamePrefix Main part of a device name.

The string for the kinect 2 is "Kinect V2" on purpose, to distinguish a "Kinect V2" device from a secondary connected "Kinect 2" (in case you have connected 2x "Kinect" and 1x Kinect V2). This case is rare, but we should be able to distinguish between cameras.

Implements mitk::IToFDeviceFactory.

Definition at line 62 of file mitkKinectV2DeviceFactory.h.

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

◆ GetFactoryName()

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

GetFactoryName Get the name of the factory.

Returns
Name as human readable string.

Implements mitk::IToFDeviceFactory.

Definition at line 49 of file mitkKinectV2DeviceFactory.h.


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