This class offers a factory method for objects of the class TrackingDeviceSource. It initializes this TrackingDeviceSource with the given navigation tools and the given tracking device. The factory method also checks if all tools are valid and of the same type like the TrackingDevice. You can do this check before trying to create the TrackingDeviceSource by calling the method IsCreateTrackingDeviceSourcePossible(), if it returns false you might want to get the error message by calling the method GetErrorMessage(). More...

#include <mitkTrackingDeviceSourceConfigurator.h>

Inheritance diagram for mitk::TrackingDeviceSourceConfigurator:

[legend]

Collaboration diagram for mitk::TrackingDeviceSourceConfigurator:

[legend]

Public Member Functions
	mitkClassMacroItkParent (TrackingDeviceSourceConfigurator, itk::Object)

	mitkNewMacro2Param (Self, mitk::NavigationToolStorage::Pointer, mitk::TrackingDevice::Pointer)

bool	IsCreateTrackingDeviceSourcePossible ()

mitk::TrackingDeviceSource::Pointer	CreateTrackingDeviceSource ()

mitk::TrackingDeviceSource::Pointer	CreateTrackingDeviceSource (mitk::NavigationDataObjectVisualizationFilter::Pointer &visualizationFilter)

int	GetToolNumberInToolStorage (unsigned int outputID)

std::string	GetToolIdentifierInToolStorage (unsigned int outputID)

std::vector< int >	GetToolNumbersInToolStorage ()

std::vector< std::string >	GetToolIdentifiersInToolStorage ()

mitk::NavigationToolStorage::Pointer	GetUpdatedNavigationToolStorage ()

std::string	GetErrorMessage ()

Protected Member Functions
	TrackingDeviceSourceConfigurator (mitk::NavigationToolStorage::Pointer NavigationTools, mitk::TrackingDevice::Pointer TrackingDevice)

virtual	~TrackingDeviceSourceConfigurator ()

mitk::NavigationDataObjectVisualizationFilter::Pointer	CreateNavigationDataObjectVisualizationFilter (mitk::TrackingDeviceSource::Pointer trackingDeviceSource, mitk::NavigationToolStorage::Pointer navigationTools)

Protected Attributes
mitk::NavigationToolStorage::Pointer	m_NavigationTools

mitk::TrackingDevice::Pointer	m_TrackingDevice

std::string	m_ErrorMessage

std::vector< int >	m_ToolCorrespondencesInToolStorage

Detailed Description

This class offers a factory method for objects of the class TrackingDeviceSource. It initializes this TrackingDeviceSource with the given navigation tools and the given tracking device. The factory method also checks if all tools are valid and of the same type like the TrackingDevice. You can do this check before trying to create the TrackingDeviceSource by calling the method IsCreateTrackingDeviceSourcePossible(), if it returns false you might want to get the error message by calling the method GetErrorMessage().

Documentation

Definition at line 40 of file mitkTrackingDeviceSourceConfigurator.h.

Constructor & Destructor Documentation

mitk::TrackingDeviceSourceConfigurator::TrackingDeviceSourceConfigurator	(	mitk::NavigationToolStorage::Pointer	NavigationTools,
		mitk::TrackingDevice::Pointer	TrackingDevice
	)

protected

Definition at line 35 of file mitkTrackingDeviceSourceConfigurator.cpp.

References m_ErrorMessage, m_NavigationTools, m_ToolCorrespondencesInToolStorage, m_TrackingDevice, and mitk::NavigationToolStorage::New().

mitk::TrackingDeviceSourceConfigurator::~TrackingDeviceSourceConfigurator ( )

protectedvirtual

Definition at line 58 of file mitkTrackingDeviceSourceConfigurator.cpp.

Member Function Documentation

mitk::NavigationDataObjectVisualizationFilter::Pointer mitk::TrackingDeviceSourceConfigurator::CreateNavigationDataObjectVisualizationFilter	(	mitk::TrackingDeviceSource::Pointer	trackingDeviceSource,
		mitk::NavigationToolStorage::Pointer	navigationTools
	)

protected

Definition at line 133 of file mitkTrackingDeviceSourceConfigurator.cpp.

References mitk::NavigationDataObjectVisualizationFilter::New().

mitk::TrackingDeviceSource::Pointer mitk::TrackingDeviceSourceConfigurator::CreateTrackingDeviceSource ( )

Returns: Returns a new TrackingDeviceSource. Returns NULL if there was an error on creating the TrackingDeviceSource. If there was an error it's availiable as error message.

Definition at line 89 of file mitkTrackingDeviceSourceConfigurator.cpp.

mitk::TrackingDeviceSource::Pointer mitk::TrackingDeviceSourceConfigurator::CreateTrackingDeviceSource ( mitk::NavigationDataObjectVisualizationFilter::Pointer & visualizationFilter )

Returns: Returns a new TrackingDeviceSource. Returns NULL if there was an error on creating the TrackingDeviceSource. If there was an error it's availiable as error message.

Parameters

visualizationFilter (return value) returns a visualization filter which is already connected to the tracking device source. This filter visualises the surfaces which are availiable by the navigation tool storage.

Definition at line 95 of file mitkTrackingDeviceSourceConfigurator.cpp.

References us::GetModuleContext(), mitk::TrackingDeviceTypeCollection::GetTrackingDeviceTypeInformation(), MITK_ERROR, and MITK_WARN.

std::string mitk::TrackingDeviceSourceConfigurator::GetErrorMessage ( )

Returns: Returns the current error message. Returns an empty string if there was no error.

Definition at line 126 of file mitkTrackingDeviceSourceConfigurator.cpp.

std::string mitk::TrackingDeviceSourceConfigurator::GetToolIdentifierInToolStorage ( unsigned int outputID )

Returns: Returns the identifier of the corresponding tool in the tool storage of a output navigation data. Returns an empty string if there was an error.

Definition at line 158 of file mitkTrackingDeviceSourceConfigurator.cpp.

std::vector< std::string > mitk::TrackingDeviceSourceConfigurator::GetToolIdentifiersInToolStorage ( )

Returns: Returns a vector with all identifier of the corresponding tools in the tool storage of all outputs. The order is the same like the order of the outputs. Returns an empty vector if there was an error.

Definition at line 169 of file mitkTrackingDeviceSourceConfigurator.cpp.

int mitk::TrackingDeviceSourceConfigurator::GetToolNumberInToolStorage ( unsigned int outputID )

Returns: Returns the internal number of the corresponding tool in the tool storage of a output navigation data. Returns -1 if there was an error.

Definition at line 152 of file mitkTrackingDeviceSourceConfigurator.cpp.

std::vector< int > mitk::TrackingDeviceSourceConfigurator::GetToolNumbersInToolStorage ( )

Returns: Returns a vector with all internal numbers of the corresponding tools in the tool storage of all outputs. The order is the same like the order of the outputs. Returns an empty vector if there was an error.

Definition at line 164 of file mitkTrackingDeviceSourceConfigurator.cpp.

mitk::NavigationToolStorage::Pointer mitk::TrackingDeviceSourceConfigurator::GetUpdatedNavigationToolStorage ( )

Returns: Returns a modified navigation tool storage which holds the tools currently in use in the same order like the output ids of the pipline.

Definition at line 52 of file mitkTrackingDeviceSourceConfigurator.cpp.

bool mitk::TrackingDeviceSourceConfigurator::IsCreateTrackingDeviceSourcePossible ( )

Returns: Returns if it's possible to create a tracking device source, which means the tools are checked if they are of the same type like the tracking device, etc. If it returns false you can get the reason for this by getting the error message.

Definition at line 62 of file mitkTrackingDeviceSourceConfigurator.cpp.

mitk::TrackingDeviceSourceConfigurator::mitkClassMacroItkParent	(	TrackingDeviceSourceConfigurator	,
		itk::Object
	)

mitk::TrackingDeviceSourceConfigurator::mitkNewMacro2Param	(	Self	,
		mitk::NavigationToolStorage::Pointer	,
		mitk::TrackingDevice::Pointer
	)

Member Data Documentation

std::string mitk::TrackingDeviceSourceConfigurator::m_ErrorMessage

protected

Definition at line 95 of file mitkTrackingDeviceSourceConfigurator.h.

Referenced by TrackingDeviceSourceConfigurator().

mitk::NavigationToolStorage::Pointer mitk::TrackingDeviceSourceConfigurator::m_NavigationTools

protected

Definition at line 93 of file mitkTrackingDeviceSourceConfigurator.h.

Referenced by TrackingDeviceSourceConfigurator().

std::vector<int> mitk::TrackingDeviceSourceConfigurator::m_ToolCorrespondencesInToolStorage

protected

Definition at line 96 of file mitkTrackingDeviceSourceConfigurator.h.

Referenced by TrackingDeviceSourceConfigurator().

mitk::TrackingDevice::Pointer mitk::TrackingDeviceSourceConfigurator::m_TrackingDevice

protected

Definition at line 94 of file mitkTrackingDeviceSourceConfigurator.h.

Referenced by TrackingDeviceSourceConfigurator().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation