diff --git a/src/Examples/CMakeLists.txt b/src/Examples/CMakeLists.txt index 30502058716dcbff0831e10012fd19c87597e449..b8e7c574a5ef525d47c68180b252355eeea73f3e 100644 --- a/src/Examples/CMakeLists.txt +++ b/src/Examples/CMakeLists.txt @@ -18,6 +18,11 @@ add_subdirectory( flow-vl ) #add_subdirectory( fast-sweeping-map ) #add_subdirectory( narrow-band ) +ADD_EXECUTABLE( FileExample FileExample.cpp ) +target_link_libraries( FileExample tnl ) ADD_EXECUTABLE( StringExample StringExample.cpp ) -target_link_libraries( StringExample tnl ) \ No newline at end of file +target_link_libraries( StringExample tnl ) + +ADD_EXECUTABLE( TimerExample TimerExample.cpp ) +target_link_libraries( TimerExample tnl ) \ No newline at end of file diff --git a/src/TNL/File.h b/src/TNL/File.h index c6f55ff7622f5784751047fb1d6ed4dad5f2ccb0..bb31cdcd27ae86d33b6bcc27479d6a1519c30993 100644 --- a/src/TNL/File.h +++ b/src/TNL/File.h @@ -37,7 +37,7 @@ enum class IOMode const size_t FileGPUvsCPUTransferBufferSize = 5 * 2<<20; -/// Class file is aimed mainly for the binary data. +///\brief Class file is aimed mainly for the binary data. /// /// \par Example /// \include FileExample.cpp diff --git a/src/TNL/Logger.h b/src/TNL/Logger.h index 10ecf800c2bebff4f249b3de7d6b16ba5c786e14..bddcfeeebe624cf2226572cfa15b2ddf1b90012d 100644 --- a/src/TNL/Logger.h +++ b/src/TNL/Logger.h @@ -15,6 +15,7 @@ namespace TNL { +/// Vytvari tabulku s logem vypoctu class Logger { public: @@ -22,41 +23,43 @@ class Logger ///// /// \brief Basic constructor. /// - /// \param _width Integer that defines the width of logger. - /// \param _stream Where to create the logger, e.g. cout or a certain files. + /// \param _width Integer that defines the width of the log. + /// \param _stream Defines output stream where the log will be printed out. Logger( int _width, std::ostream& _stream ); ///// - /// \brief Creates header in given logger. + /// \brief Creates header in given log. + /// + /// The header usually contains title of the program. /// - /// \param title String desribing the title/header. + /// \param title String containing the header title. void writeHeader( const String& title ); - /// \brief Creates predefined separator - structure in the logger. + /// \brief Creates separator for structuring the log. void writeSeparator(); - /// \brief Inserts information about various system parameters into logger. + /// \brief Inserts information about various system parameters into the log. /// - /// \param parameters + /// \param parameters is a container with configuration parameters bool writeSystemInformation( const Config::ParameterContainer& parameters ); ///// - /// \brief Inserts a line with current time into logger. + /// \brief Inserts a line with current time into the log. /// - /// \param label Description of the current time line. + /// \param label Label to be printed to the log together with the current time. void writeCurrentTime( const char* label ); // TODO: add units - template< typename T > + template< typename ParameterType > void writeParameter( const String& label, const String& parameterName, const Config::ParameterContainer& parameters, int parameterLevel = 0 ); - template< typename T > + template< typename ParameterType > void writeParameter( const String& label, - const T& value, + const ParameterType& value, int parameterLevel = 0 ); protected: diff --git a/src/TNL/Logger_impl.h b/src/TNL/Logger_impl.h index e502332662a02312e97d80778603333243c2432b..08181070f48b33ca691c93f1ae0b9b7b78a17d97 100644 --- a/src/TNL/Logger_impl.h +++ b/src/TNL/Logger_impl.h @@ -15,7 +15,7 @@ namespace TNL { -template< typename T > +template< typename ParameterType > void Logger::writeParameter( const String& label, const String& parameterName, const Config::ParameterContainer& parameters, @@ -26,16 +26,16 @@ void Logger::writeParameter( const String& label, for( i = 0; i < parameterLevel; i ++ ) stream << " "; std::stringstream str; - str << parameters.getParameter< T >( parameterName ); + str << parameters.getParameter< ParameterType >( parameterName ); stream << label << std::setw( width - label.getLength() - parameterLevel - 3 ) << str.str() << " |" << std::endl; } -template< typename T > +template< typename ParameterType > void Logger :: writeParameter( const String& label, - const T& value, - int parameterLevel ) + const ParameterType& value, + int parameterLevel ) { stream << "| "; int i; diff --git a/src/TNL/Timer.h b/src/TNL/Timer.h index 1ccc275378a5de5cfe12a2260487d1ad7cf5bae4..f347c45102baef7a61c90639ab70a53ca7f34165 100644 --- a/src/TNL/Timer.h +++ b/src/TNL/Timer.h @@ -54,7 +54,7 @@ class Timer void start(); ///// - /// \brief Returs the elapsed time on given timer. + /// \brief Returns the elapsed time on given timer. /// /// It returns the elapsed time between calling the start() and stop() functions. /// Starts counting the real time after the function start() is called and