OMSimulatorLib The OMSimulator project is a FMI-based co-simulation environment.

Loading...
Searching...
No Matches
Clocks.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenModelica.
3 *
4 * Copyright (c) 1998-2026, 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 AGPL VERSION 3 LICENSE OR
11 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
12 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
13 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
14 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
15 *
16 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
17 * Public License (OSMC-PL) are obtained from OSMC, either from the above
18 * address, from the URLs:
19 * http://www.openmodelica.org or
20 * https://github.com/OpenModelica/ or
21 * http://www.ida.liu.se/projects/OpenModelica,
22 * and in the OpenModelica distribution.
23 *
24 * GNU AGPL version 3 is obtained from:
25 * https://www.gnu.org/licenses/licenses.html#GPL
26 *
27 * This program is distributed WITHOUT ANY WARRANTY; without
28 * even the implied warranty of MERCHANTABILITY or FITNESS
29 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
30 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
31 *
32 * See the full OSMC Public License conditions for more details.
33 *
34 */
35
36#ifndef _OMS_CLOCKS_H_
37#define _OMS_CLOCKS_H_
38
39#include "Clock.h"
40
41#include <string>
42#include <stack>
43
44#define OMS_USE_CLOCKS
45
46#ifdef OMS_USE_CLOCKS
47 #define OMS_TIC(clocks, index) clocks.tic(index)
48 #define OMS_TOC(clocks, index) clocks.toc(index)
49#else
50 #define OMS_TIC(clocks, index) ((void)0)
51 #define OMS_TOC(clocks, index) ((void)0)
52#endif
53
54 enum GlobalClockIndex_t
55{
56 GLOBALCLOCK_IDLE = 0,
57 GLOBALCLOCK_INSTANTIATION,
58 GLOBALCLOCK_INITIALIZATION,
59 GLOBALCLOCK_SIMULATION,
60 GLOBALCLOCK_COMMUNICATION,
61 GLOBALCLOCK_RESULTFILE,
62
63 GLOBALCLOCK_MAX_INDEX
64};
65
66 class Clocks
67{
68 public:
69 Clocks(int numSubClocks);
70 ~Clocks();
71
72 void tic(int clock);
73 void toc(int clock);
74 void getStats(double* cpuStats, double* wallStats);
75
76 private:
77 int numSubClocks;
78 Clock *clocks;
79 std::stack<int> activeClocks;
80
81 private:
82 // Stop the compiler generating methods of copy the object
83 Clocks(Clocks const& copy); // Not Implemented
84 Clocks& operator=(Clocks const& copy); // Not Implemented
85};
86
87 extern Clocks globalClocks;
88 extern const char* GlobalClockNames[GLOBALCLOCK_MAX_INDEX];
89
90#endif
Clock.h
GlobalClockIndex_t
GlobalClockIndex_t
Definition Clocks.h:55
GLOBALCLOCK_SIMULATION
@ GLOBALCLOCK_SIMULATION
Definition Clocks.h:59
GLOBALCLOCK_RESULTFILE
@ GLOBALCLOCK_RESULTFILE
Definition Clocks.h:61
GLOBALCLOCK_INITIALIZATION
@ GLOBALCLOCK_INITIALIZATION
Definition Clocks.h:58
GLOBALCLOCK_MAX_INDEX
@ GLOBALCLOCK_MAX_INDEX
Definition Clocks.h:63
GLOBALCLOCK_INSTANTIATION
@ GLOBALCLOCK_INSTANTIATION
Definition Clocks.h:57
GLOBALCLOCK_COMMUNICATION
@ GLOBALCLOCK_COMMUNICATION
Definition Clocks.h:60
GLOBALCLOCK_IDLE
@ GLOBALCLOCK_IDLE
Definition Clocks.h:56
globalClocks
Clocks globalClocks
GlobalClockNames
const char * GlobalClockNames[GLOBALCLOCK_MAX_INDEX]
Definition Clocks.cpp:45
Clock
Definition Clock.h:43
Clocks
Definition Clocks.h:67
Clocks::toc
void toc(int clock)
Definition Clocks.cpp:89
Clocks::numSubClocks
int numSubClocks
Definition Clocks.h:77
Clocks::Clocks
Clocks(Clocks const &copy)
Clocks::operator=
Clocks & operator=(Clocks const &copy)
Clocks::tic
void tic(int clock)
Definition Clocks.cpp:74
Clocks::~Clocks
~Clocks()
Definition Clocks.cpp:66
Clocks::getStats
void getStats(double *cpuStats, double *wallStats)
Definition Clocks.cpp:107
Clocks::activeClocks
std::stack< int > activeClocks
Definition Clocks.h:79
Clocks::clocks
Clock * clocks
Definition Clocks.h:78