Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
tnl-dev
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
TNL
tnl-dev
Commits
85aae073
There was an error fetching the commit references. Please try again later.
Commit
85aae073
authored
6 years ago
by
Nina Džugasová
Committed by
Tomáš Oberhuber
6 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Added Logger documentation.
parent
5a334993
No related branches found
No related tags found
1 merge request
!15
Nina
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/TNL/Containers/List.h
+1
-0
1 addition, 0 deletions
src/TNL/Containers/List.h
src/TNL/Logger.h
+17
-3
17 additions, 3 deletions
src/TNL/Logger.h
with
18 additions
and
3 deletions
src/TNL/Containers/List.h
+
1
−
0
View file @
85aae073
...
@@ -59,6 +59,7 @@ template< class T > class List
...
@@ -59,6 +59,7 @@ template< class T > class List
/// Destroys the list. References to the values in the list become invalid.
/// Destroys the list. References to the values in the list become invalid.
~
List
();
~
List
();
/// Returns the type of list.
static
String
getType
();
static
String
getType
();
/// Returns \e true if the list contains no items, otherwise returns \e false.
/// Returns \e true if the list contains no items, otherwise returns \e false.
...
...
This diff is collapsed.
Click to expand it.
src/TNL/Logger.h
+
17
−
3
View file @
85aae073
...
@@ -15,7 +15,7 @@
...
@@ -15,7 +15,7 @@
namespace
TNL
{
namespace
TNL
{
///
Vytvari tabulku s logem vypoctu
///
Creates calculations log in the form of a table.
class
Logger
class
Logger
{
{
public:
public:
...
@@ -36,12 +36,12 @@ class Logger
...
@@ -36,12 +36,12 @@ class Logger
/// \param title String containing the header title.
/// \param title String containing the header title.
void
writeHeader
(
const
String
&
title
);
void
writeHeader
(
const
String
&
title
);
/// \brief Creates separator
for structuring the log
.
/// \brief Creates separator
used as a log structure
.
void
writeSeparator
();
void
writeSeparator
();
/// \brief Inserts information about various system parameters into the log.
/// \brief Inserts information about various system parameters into the log.
///
///
/// \param parameters
is a
container with configuration parameters
/// \param parameters
A
container with configuration parameters
.
bool
writeSystemInformation
(
const
Config
::
ParameterContainer
&
parameters
);
bool
writeSystemInformation
(
const
Config
::
ParameterContainer
&
parameters
);
/////
/////
...
@@ -50,6 +50,14 @@ class Logger
...
@@ -50,6 +50,14 @@ class Logger
/// \param label Label to be printed to the log together with the current time.
/// \param label Label to be printed to the log together with the current time.
void
writeCurrentTime
(
const
char
*
label
);
void
writeCurrentTime
(
const
char
*
label
);
/// \brief Inserts parameter information into the log.
///
/// \tparam ParameterType Type of the parameter.
/// \param label Description/label of the line.
/// \param parameterName Name of the parameter.
/// \param parameters A container with configuration parameters.
/// \param parameterLevel Integer defining the indent used in the log.
// TODO: add units
// TODO: add units
template
<
typename
ParameterType
>
template
<
typename
ParameterType
>
void
writeParameter
(
const
String
&
label
,
void
writeParameter
(
const
String
&
label
,
...
@@ -57,6 +65,12 @@ class Logger
...
@@ -57,6 +65,12 @@ class Logger
const
Config
::
ParameterContainer
&
parameters
,
const
Config
::
ParameterContainer
&
parameters
,
int
parameterLevel
=
0
);
int
parameterLevel
=
0
);
/// \brief Inserts parameter information into the log.
///
/// \tparam ParameterType Type of the parameter.
/// \param label Description/label of the line.
/// \param value Parameter value.
/// \param parameterLevel Integer defining the indent used in the log.
template
<
typename
ParameterType
>
template
<
typename
ParameterType
>
void
writeParameter
(
const
String
&
label
,
void
writeParameter
(
const
String
&
label
,
const
ParameterType
&
value
,
const
ParameterType
&
value
,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment