Medical Imaging Interaction Toolkit  2018.4.99-08619e4f
Medical Imaging Interaction Toolkit
mitk::TrackingDeviceTypeCollection Class Reference

This class is a collection for information of all Tracking Device Types (derived from abstract TrackingDeviceTypeInformation) The Collection is avaiable via Microservice. If you want to add your own tracking device (e.g. to the Tracking Toolbox), you should register information about your tracking device in this collection using the RegisterTrackingDeviceType function. More...

#include <mitkTrackingDeviceTypeCollection.h>

Public Member Functions

 TrackingDeviceTypeCollection ()
 
 ~TrackingDeviceTypeCollection ()
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. More...
 
void RegisterTrackingDeviceType (TrackingDeviceTypeInformation *typeInformation)
 
TrackingDeviceTypeInformationGetTrackingDeviceTypeInformation (TrackingDeviceType type)
 
std::vector< std::string > GetTrackingDeviceTypeNames ()
 
std::vector< TrackingDeviceDataGetDeviceDataForLine (TrackingDeviceType type)
 
TrackingDeviceData GetFirstCompatibleDeviceDataForLine (TrackingDeviceType type)
 
TrackingDeviceData GetDeviceDataByName (const std::string &modelName)
 

Detailed Description

This class is a collection for information of all Tracking Device Types (derived from abstract TrackingDeviceTypeInformation) The Collection is avaiable via Microservice. If you want to add your own tracking device (e.g. to the Tracking Toolbox), you should register information about your tracking device in this collection using the RegisterTrackingDeviceType function.

Documentation: The Microservice provides all compatible TrackingDeviceDatas for a requested tracking device type or a list of all available Tracking Devices.

Definition at line 35 of file mitkTrackingDeviceTypeCollection.h.

Constructor & Destructor Documentation

◆ TrackingDeviceTypeCollection()

mitk::TrackingDeviceTypeCollection::TrackingDeviceTypeCollection ( )

Definition at line 22 of file mitkTrackingDeviceTypeCollection.cpp.

◆ ~TrackingDeviceTypeCollection()

mitk::TrackingDeviceTypeCollection::~TrackingDeviceTypeCollection ( )

Definition at line 28 of file mitkTrackingDeviceTypeCollection.cpp.

Member Function Documentation

◆ GetDeviceDataByName()

mitk::TrackingDeviceData mitk::TrackingDeviceTypeCollection::GetDeviceDataByName ( const std::string &  modelName)

/brief Returns the device Data set matching the model name or the invalid device, if none was found.

Definition at line 97 of file mitkTrackingDeviceTypeCollection.cpp.

References mitk::UnspecifiedTrackingTypeInformation::GetDeviceDataInvalid().

◆ GetDeviceDataForLine()

std::vector< mitk::TrackingDeviceData > mitk::TrackingDeviceTypeCollection::GetDeviceDataForLine ( TrackingDeviceType  type)

/brief Returns all devices compatibel to the given Line of Devices

Definition at line 74 of file mitkTrackingDeviceTypeCollection.cpp.

Referenced by GetFirstCompatibleDeviceDataForLine().

◆ GetFirstCompatibleDeviceDataForLine()

mitk::TrackingDeviceData mitk::TrackingDeviceTypeCollection::GetFirstCompatibleDeviceDataForLine ( TrackingDeviceType  type)

/brief Returns the first TrackingDeviceData matching a given line. Useful for backward compatibility with the old way to manage devices.

Definition at line 87 of file mitkTrackingDeviceTypeCollection.cpp.

References GetDeviceDataForLine(), and mitk::UnspecifiedTrackingTypeInformation::GetDeviceDataInvalid().

Referenced by mitk::TrackingVolumeGenerator::SetTrackingDevice(), mitk::TrackingVolumeGenerator::SetTrackingDeviceType(), and mitk::TrackingDevice::SetType().

◆ GetTrackingDeviceTypeInformation()

mitk::TrackingDeviceTypeInformation * mitk::TrackingDeviceTypeCollection::GetTrackingDeviceTypeInformation ( mitk::TrackingDeviceType  type)

◆ GetTrackingDeviceTypeNames()

std::vector< std::string > mitk::TrackingDeviceTypeCollection::GetTrackingDeviceTypeNames ( )

◆ RegisterAsMicroservice()

void mitk::TrackingDeviceTypeCollection::RegisterAsMicroservice ( )
virtual

Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

Definition at line 40 of file mitkTrackingDeviceTypeCollection.cpp.

References us::GetModuleContext().

Referenced by mitk::IGTActivator::Load().

◆ RegisterTrackingDeviceType()

void mitk::TrackingDeviceTypeCollection::RegisterTrackingDeviceType ( TrackingDeviceTypeInformation typeInformation)

Definition at line 53 of file mitkTrackingDeviceTypeCollection.cpp.

Referenced by mitk::IGTActivator::Load().

◆ UnRegisterMicroservice()

void mitk::TrackingDeviceTypeCollection::UnRegisterMicroservice ( )
virtual

Registers this object as a Microservice, making it available to every module and/or plugin.

Definition at line 47 of file mitkTrackingDeviceTypeCollection.cpp.

Referenced by mitk::IGTActivator::Unload().


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