Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::ToFCameraPMDPlayerDeviceFactory Class Reference

ToFPMDPlayerDeviceFactory is an implementation of the factory pattern to generate PMD Player Devices. ToFPMDPlayerDeviceFactory inherits from AbstractToFDeviceFactory which is a MicroService interface. This offers users the oppertunity to generate new PMD Player Devices via a global instance of this factory. More...

#include <mitkToFCameraPMDPlayerDeviceFactory.h>

Inheritance diagram for mitk::ToFCameraPMDPlayerDeviceFactory:
Collaboration diagram for mitk::ToFCameraPMDPlayerDeviceFactory:

Public Member Functions

 ToFCameraPMDPlayerDeviceFactory ()
 ToFCameraPMDPlayerDeviceFactory Default contructor. This factory internally counts all PMD Player devices starting at 1. More...
 
std::string GetFactoryName ()
 Get the name of the factory, here for the ToFPMDPlayer. More...
 
std::string GetDeviceNamePrefix ()
 GetCurrentDeviceName Get the name of the current Cam Cube. First device is named "PMD Player", second "PMD Player 2" and so on. 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...
 
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...
 
virtual us::ModuleResource GetIntrinsicsResource ()
 Returns the ModuleResource that contains a xml definition of the CameraIntrinsics. 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

ToFPMDPlayerDeviceFactory is an implementation of the factory pattern to generate PMD Player Devices. ToFPMDPlayerDeviceFactory inherits from AbstractToFDeviceFactory which is a MicroService interface. This offers users the oppertunity to generate new PMD Player Devices via a global instance of this factory.

Definition at line 30 of file mitkToFCameraPMDPlayerDeviceFactory.h.

Constructor & Destructor Documentation

◆ ToFCameraPMDPlayerDeviceFactory()

mitk::ToFCameraPMDPlayerDeviceFactory::ToFCameraPMDPlayerDeviceFactory ( )
inline

ToFCameraPMDPlayerDeviceFactory Default contructor. This factory internally counts all PMD Player devices starting at 1.

Definition at line 37 of file mitkToFCameraPMDPlayerDeviceFactory.h.

Member Function Documentation

◆ GetDeviceNamePrefix()

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

GetCurrentDeviceName Get the name of the current Cam Cube. First device is named "PMD Player", second "PMD Player 2" and so on.

Returns
Human readable name as string.

Implements mitk::IToFDeviceFactory.

Definition at line 53 of file mitkToFCameraPMDPlayerDeviceFactory.h.

◆ GetFactoryName()

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

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

Implements mitk::IToFDeviceFactory.

Definition at line 43 of file mitkToFCameraPMDPlayerDeviceFactory.h.


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