mitk::USNavigationStepTimer Class Reference

Timer for measureing the durations of navigation steps. The different steps are identified by indices. To measure the duraion of a step it can be activated by calling SetActiveIndex(). The duration is measured until another step is activated by calling SetActiveIndex() with an other index or Stop() is called. More...

#include <mitkUSNavigationStepTimer.h>

Inheritance diagram for mitk::USNavigationStepTimer:

Classes
struct	DurationForIndex

Public Member Functions
	mitkClassMacroItkParent (USNavigationStepTimer, itk::Object)
	itkNewMacro (USNavigationStepTimer)
void	Stop ()
	Stops the timer for the current index. The measured time to if written to the output file if a file path was already set.
void	Reset ()
	Removes all measured durations.
void	SetOutputFileName (std::string filename)
	Sets the name of the output file. If there are already measurements of durations, they are written to this file immediately.
void	SetActiveIndex (unsigned int index, std::string description="")
	Starts measurement for the step with the given index.
double	GetTotalDuration ()
	Returns the sum of all durations.
double	GetDurationForIndex (unsigned int index)
	Returns measured duration for the step with the given index. All measurements of this index are summed up.
void	ReadFromFile (std::string filename)
	Read durations from the file of the given file name. This file must have exactly the same format as it is written by this class.

Protected Types
typedef std::vector< DurationForIndex >	DurationsVector

Protected Member Functions
	USNavigationStepTimer ()
	~USNavigationStepTimer () override
void	FinishCurrentIndex ()
void	WriteLineToFile (const DurationForIndex &element)
void	WriteEverythingToFile ()

Protected Attributes
DurationsVector	m_Durations
unsigned int	m_CurrentIndex
std::string	m_CurrentDescription
itk::TimeProbe	m_TimeProbe
std::string	m_OutputFileName

Detailed Description

Timer for measureing the durations of navigation steps. The different steps are identified by indices. To measure the duraion of a step it can be activated by calling SetActiveIndex(). The duration is measured until another step is activated by calling SetActiveIndex() with an other index or Stop() is called.

If a file name for an output file was set (SetOutputFileName()), the results are written to this file, every time a new duration was measured. If a file name is set later on, the results are written to the file at the moment of setting the file name.

Definition at line 35 of file mitkUSNavigationStepTimer.h.

Member Typedef Documentation

DurationsVector

std::vector<DurationForIndex> mitk::USNavigationStepTimer::DurationsVector

protected

Definition at line 98 of file mitkUSNavigationStepTimer.h.

Constructor & Destructor Documentation

USNavigationStepTimer()

mitk::USNavigationStepTimer::USNavigationStepTimer ( )

protected

Definition at line 18 of file mitkUSNavigationStepTimer.cpp.

~USNavigationStepTimer()

mitk::USNavigationStepTimer::~USNavigationStepTimer ( )

overrideprotected

Definition at line 23 of file mitkUSNavigationStepTimer.cpp.

Member Function Documentation

FinishCurrentIndex()

void mitk::USNavigationStepTimer::FinishCurrentIndex ( )

protected

Definition at line 87 of file mitkUSNavigationStepTimer.cpp.

GetDurationForIndex()

double mitk::USNavigationStepTimer::GetDurationForIndex

(

unsigned int

index

)

Returns measured duration for the step with the given index. All measurements of this index are summed up.

Definition at line 73 of file mitkUSNavigationStepTimer.cpp.

GetTotalDuration()

double mitk::USNavigationStepTimer::GetTotalDuration

(

)

Returns the sum of all durations.

Definition at line 59 of file mitkUSNavigationStepTimer.cpp.

itkNewMacro()

mitk::USNavigationStepTimer::itkNewMacro

(

USNavigationStepTimer

)

mitkClassMacroItkParent()

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

ReadFromFile()

void mitk::USNavigationStepTimer::ReadFromFile

(

std::string

filename

)

Read durations from the file of the given file name. This file must have exactly the same format as it is written by this class.

Definition at line 140 of file mitkUSNavigationStepTimer.cpp.

Reset()

void mitk::USNavigationStepTimer::Reset

(

)

Removes all measured durations.

Definition at line 35 of file mitkUSNavigationStepTimer.cpp.

SetActiveIndex()

void mitk::USNavigationStepTimer::SetActiveIndex	(	unsigned int	index,
		std::string	description = "" )

Starts measurement for the step with the given index.

Definition at line 49 of file mitkUSNavigationStepTimer.cpp.

SetOutputFileName()

void mitk::USNavigationStepTimer::SetOutputFileName

(

std::string

filename

)

Sets the name of the output file. If there are already measurements of durations, they are written to this file immediately.

Definition at line 41 of file mitkUSNavigationStepTimer.cpp.

Stop()

void mitk::USNavigationStepTimer::Stop

(

)

Stops the timer for the current index. The measured time to if written to the output file if a file path was already set.

Definition at line 30 of file mitkUSNavigationStepTimer.cpp.

WriteEverythingToFile()

void mitk::USNavigationStepTimer::WriteEverythingToFile ( )

protected

Definition at line 104 of file mitkUSNavigationStepTimer.cpp.

WriteLineToFile()

void mitk::USNavigationStepTimer::WriteLineToFile ( const DurationForIndex & element )

protected

Definition at line 124 of file mitkUSNavigationStepTimer.cpp.

Member Data Documentation

m_CurrentDescription

std::string mitk::USNavigationStepTimer::m_CurrentDescription

protected

Definition at line 102 of file mitkUSNavigationStepTimer.h.

m_CurrentIndex

unsigned int mitk::USNavigationStepTimer::m_CurrentIndex

protected

Definition at line 101 of file mitkUSNavigationStepTimer.h.

m_Durations

DurationsVector mitk::USNavigationStepTimer::m_Durations

protected

Definition at line 99 of file mitkUSNavigationStepTimer.h.

m_OutputFileName

std::string mitk::USNavigationStepTimer::m_OutputFileName

protected

Definition at line 105 of file mitkUSNavigationStepTimer.h.

m_TimeProbe

itk::TimeProbe mitk::USNavigationStepTimer::m_TimeProbe

protected

Definition at line 103 of file mitkUSNavigationStepTimer.h.

---

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

• Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/IO/mitkUSNavigationStepTimer.h
• Plugins/org.mitk.gui.qt.igt.app.ultrasoundtrackingnavigation/src/internal/IO/mitkUSNavigationStepTimer.cpp