Spinning Topp Logo BlackTopp Studios
inc
logtools.cpp
Go to the documentation of this file.
1 // The DAGFrameScheduler is a Multi-Threaded lock free and wait free scheduling library.
2 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
3 /* This file is part of The DAGFrameScheduler.
4 
5  The DAGFrameScheduler is free software: you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation, either version 3 of the License, or
8  (at your option) any later version.
9 
10  The DAGFrameScheduler is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with The DAGFrameScheduler. If not, see <http://www.gnu.org/licenses/>.
17 */
18 /* The original authors have included a copy of the license specified above in the
19  'doc' folder. See 'gpl.txt'
20 */
21 /* We welcome the use of the DAGFrameScheduler to anyone, including companies who wish to
22  Build professional software and charge for their product.
23 
24  However there are some practical restrictions, so if your project involves
25  any of the following you should contact us and we will try to work something
26  out:
27  - DRM or Copy Protection of any kind(except Copyrights)
28  - Software Patents You Do Not Wish to Freely License
29  - Any Kind of Linking to Non-GPL licensed Works
30  - Are Currently In Violation of Another Copyright Holder's GPL License
31  - If You want to change our code and not add a few hundred MB of stuff to
32  your distribution
33 
34  These and other limitations could cause serious legal problems if you ignore
35  them, so it is best to simply contact us or the Free Software Foundation, if
36  you have any questions.
37 
38  Joseph Toppi - toppij@gmail.com
39  John Blackwood - makoenergy02@gmail.com
40 */
41 #ifndef _logtools_cpp
42 #define _logtools_cpp
43 
44 #include "logtools.h"
45 
46 /// @file
47 /// @brief Tools that make logging specific data a little bit easier
48 
49 namespace Mezzanine
50 {
51  namespace Threading
52  {
53  ScopedTimer::ScopedTimer(std::ostream& LogSink,
54  String ScopeToMeasure,
55  String ScopeFile,
56  Whole CurrentLine
57  ) :
58  LogTarget(LogSink),
59  ScopeName(ScopeToMeasure),
60  FileName(ScopeFile),
61  StartTime(GetTimeStamp()),
62  Line(CurrentLine)
63  {
64  LogTarget << "<ScopedTimerBegin "
65  "TimeStamp=\"" << StartTime << "\" "
66  "Scope=\"" << ScopeName << "\" "
67  "FileName=\"" << FileName << "\" "
68  "Line=\"" << CurrentLine << "\" "
69  "/>" << std::endl;
70  }
71 
73  {
75  LogTarget << "<ScopedTimerEnd "
76  "TimeStamp=\"" << Now << "\" "
77  "Duration=\"" << (Now-StartTime) << "\" "
78  "/>" << std::endl;
79  }
80 
81 
82  }//Threading
83 }//Mezzanine
84 #endif
MaxInt GetTimeStamp()
Get a timestamp, in microseconds. This will generally be some multiple of the GetTimeStampResolution ...
MaxInt Now()
Get a timestamp, in microseconds. This will generally be some multiple of the GetTimeStampResolution ...
~ScopedTimer()
Destructor, logs duration and current timestamp in ScopedTimerEnd xml element.
Definition: logtools.cpp:72
The definitions of the logging tools.
long long MaxInt
A large integer type suitable for compile time math and long term microsecond time keeping...
Definition: datatypes.h:190
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
unsigned long Whole
Whole is an unsigned integer, it will be at least 32bits in size.
Definition: datatypes.h:151
ScopedTimer(std::ostream &LogSink=std::cout, String ScopeToMeasure="UnknownScope", String ScopeFile=String(), Whole CurrentLine=0)
In a ScopedTimerBegin xml element this logs every parameter and the current timestamp.
Definition: logtools.cpp:53
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159