OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Clocks.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenModelica.
3  *
4  * Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
5  * c/o Linköpings universitet, Department of Computer and Information Science,
6  * SE-58183 Linköping, Sweden.
7  *
8  * All rights reserved.
9  *
10  * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
11  * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
12  * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13  * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
14  * ACCORDING TO RECIPIENTS CHOICE.
15  *
16  * The OpenModelica software and the Open Source Modelica
17  * Consortium (OSMC) Public License (OSMC-PL) are obtained
18  * from OSMC, either from the above address,
19  * from the URLs: http://www.ida.liu.se/projects/OpenModelica or
20  * http://www.openmodelica.org, and in the OpenModelica distribution.
21  * GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
22  *
23  * This program is distributed WITHOUT ANY WARRANTY; without
24  * even the implied warranty of MERCHANTABILITY or FITNESS
25  * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
26  * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
27  *
28  * See the full OSMC Public License conditions for more details.
29  *
30  */
31 
32 #ifndef _OMS_CLOCKS_H_
33 #define _OMS_CLOCKS_H_
34 
35 #include "Clock.h"
36 
37 #include <string>
38 #include <stack>
39 
40 #define OMS_USE_CLOCKS
41 
42 #ifdef OMS_USE_CLOCKS
43  #define OMS_TIC(clocks, index) clocks.tic(index)
44  #define OMS_TOC(clocks, index) clocks.toc(index)
45 #else
46  #define OMS_TIC(clocks, index) ((void)0)
47  #define OMS_TOC(clocks, index) ((void)0)
48 #endif
49 
51 {
58 
60 };
61 
62 class Clocks
63 {
64 public:
65  Clocks(int numSubClocks);
66  ~Clocks();
67 
68  void tic(int clock);
69  void toc(int clock);
70  void getStats(double* cpuStats, double* wallStats);
71 
72 private:
75  std::stack<int> activeClocks;
76 
77 private:
78  // Stop the compiler generating methods of copy the object
79  Clocks(Clocks const& copy); // Not Implemented
80  Clocks& operator=(Clocks const& copy); // Not Implemented
81 };
82 
83 extern Clocks globalClocks;
84 extern const char* GlobalClockNames[GLOBALCLOCK_MAX_INDEX];
85 
86 #endif
Clocks::clocks
Clock * clocks
Definition: Clocks.h:74
Util.h
Clock
Definition: Clock.h:38
Clocks::numSubClocks
int numSubClocks
Definition: Clocks.h:73
Clock::getElapsedWallTime
double & getElapsedWallTime()
Definition: Clock.cpp:92
Clocks.h
globalClocks
Clocks globalClocks(GLOBALCLOCK_MAX_INDEX)
GLOBALCLOCK_COMMUNICATION
@ GLOBALCLOCK_COMMUNICATION
Definition: Clocks.h:56
Clock::tic
void tic()
Definition: Clock.cpp:47
GlobalClockNames
const char * GlobalClockNames[GLOBALCLOCK_MAX_INDEX]
Definition: Clocks.cpp:41
Clocks::tic
void tic(int clock)
Definition: Clocks.cpp:70
Clocks::~Clocks
~Clocks()
Definition: Clocks.cpp:62
Clock.h
Clocks::activeClocks
std::stack< int > activeClocks
Definition: Clocks.h:75
Clocks::getStats
void getStats(double *cpuStats, double *wallStats)
Definition: Clocks.cpp:103
Clocks::Clocks
Clocks(int numSubClocks)
Definition: Clocks.cpp:50
Clocks
Definition: Clocks.h:62
Clocks::operator=
Clocks & operator=(Clocks const &copy)
GLOBALCLOCK_INITIALIZATION
@ GLOBALCLOCK_INITIALIZATION
Definition: Clocks.h:54
Clock::toc
void toc()
Definition: Clock.cpp:57
GLOBALCLOCK_RESULTFILE
@ GLOBALCLOCK_RESULTFILE
Definition: Clocks.h:57
GlobalClockNames
const char * GlobalClockNames[GLOBALCLOCK_MAX_INDEX]
Definition: Clocks.cpp:41
globalClocks
Clocks globalClocks
GLOBALCLOCK_SIMULATION
@ GLOBALCLOCK_SIMULATION
Definition: Clocks.h:55
GLOBALCLOCK_IDLE
@ GLOBALCLOCK_IDLE
Definition: Clocks.h:52
logError
#define logError(msg)
Definition: Logging.h:102
GLOBALCLOCK_INSTANTIATION
@ GLOBALCLOCK_INSTANTIATION
Definition: Clocks.h:53
GLOBALCLOCK_MAX_INDEX
@ GLOBALCLOCK_MAX_INDEX
Definition: Clocks.h:59
Logging.h
Clock::getElapsedCPUTime
double & getElapsedCPUTime()
Definition: Clock.cpp:81
GlobalClockIndex_t
GlobalClockIndex_t
Definition: Clocks.h:50
Clocks::toc
void toc(int clock)
Definition: Clocks.cpp:85