MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mitk::USNavigationLoggingBackend Class Reference

Backend for the MITK log mechanism. This backend writes all messages to the given file. More...

#include <mitkUSNavigationLoggingBackend.h>

Inheritance diagram for mitk::USNavigationLoggingBackend:

Public Member Functions

 USNavigationLoggingBackend ()
 
 ~USNavigationLoggingBackend () override
 
void SetOutputFileName (std::string filename)
 Set file path und name for the output file. The file will be opened and all log messages will be directed there from then on.
 
void ProcessMessage (const LogMessage &logMessage) override
 This method is called by the mbi logging mechanism if the object is registered in the mbi logging mechanism and a logging message is emitted. The method formats the logging messages to a normal string (depending on formatting mode) and writes it to std::cout.
 
std::vector< std::string > GetNavigationMessages ()
 
void WriteCSVFileWithNavigationMessages (std::string filename)
 
void ClearNavigationMessages ()
 
OutputType GetOutputType () const override
 

Detailed Description

Backend for the MITK log mechanism. This backend writes all messages to the given file.

Definition at line 27 of file mitkUSNavigationLoggingBackend.h.

Constructor & Destructor Documentation

◆ USNavigationLoggingBackend()

mitk::USNavigationLoggingBackend::USNavigationLoggingBackend ( )

Definition at line 17 of file mitkUSNavigationLoggingBackend.cpp.

◆ ~USNavigationLoggingBackend()

mitk::USNavigationLoggingBackend::~USNavigationLoggingBackend ( )
override

Definition at line 21 of file mitkUSNavigationLoggingBackend.cpp.

Member Function Documentation

◆ ClearNavigationMessages()

void mitk::USNavigationLoggingBackend::ClearNavigationMessages ( )

Clears the internally stored navigation messages of the category "USNavigationLogging".

Definition at line 66 of file mitkUSNavigationLoggingBackend.cpp.

◆ GetNavigationMessages()

std::vector< std::string > mitk::USNavigationLoggingBackend::GetNavigationMessages ( )
Returns
Returns all messages of the category "USNavigationLogging" since the last call of ClearNavigationMessages().

Definition at line 49 of file mitkUSNavigationLoggingBackend.cpp.

◆ GetOutputType()

mitk::LogBackendBase::OutputType mitk::USNavigationLoggingBackend::GetOutputType ( ) const
override

Definition at line 71 of file mitkUSNavigationLoggingBackend.cpp.

◆ ProcessMessage()

void mitk::USNavigationLoggingBackend::ProcessMessage ( const LogMessage & logMessage)
override

This method is called by the mbi logging mechanism if the object is registered in the mbi logging mechanism and a logging message is emitted. The method formats the logging messages to a normal string (depending on formatting mode) and writes it to std::cout.

Parameters
logMessageLogging message.

Definition at line 39 of file mitkUSNavigationLoggingBackend.cpp.

◆ SetOutputFileName()

void mitk::USNavigationLoggingBackend::SetOutputFileName ( std::string filename)

Set file path und name for the output file. The file will be opened and all log messages will be directed there from then on.

Exceptions
mitk::Exceptionif the file cannot be opened

Definition at line 26 of file mitkUSNavigationLoggingBackend.cpp.

◆ WriteCSVFileWithNavigationMessages()

void mitk::USNavigationLoggingBackend::WriteCSVFileWithNavigationMessages ( std::string filename)

Writes a CSV file containing all stored navigation messages to the given output filename.

Definition at line 54 of file mitkUSNavigationLoggingBackend.cpp.

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