Clocks.h

Go to the documentation of this file.

/*
 * This file is part of OpenModelica.
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
 * c/o Linköpings universitet, Department of Computer and Information Science,
 * SE-58183 Linköping, Sweden.
 *
 * All rights reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
 * Public License (OSMC-PL) are obtained from OSMC, either from the above
 * address, from the URLs:
 * http://www.openmodelica.org or
 * https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica,
 * and in the OpenModelica distribution.
 *
 * GNU AGPL version 3 is obtained from:
 * https://www.gnu.org/licenses/licenses.html#GPL
 *
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
 *
 * See the full OSMC Public License conditions for more details.
 *
 */
 
#ifndef _OMS_CLOCKS_H_
#define _OMS_CLOCKS_H_
 
#include "Clock.h"
 
#include <string>
#include <stack>
 
#define OMS_USE_CLOCKS
 
#ifdef OMS_USE_CLOCKS
  #define OMS_TIC(clocks, index) clocks.tic(index)
  #define OMS_TOC(clocks, index) clocks.toc(index)
#else
  #define OMS_TIC(clocks, index) ((void)0)
  #define OMS_TOC(clocks, index) ((void)0)
#endif
 
enum GlobalClockIndex_t
{
  GLOBALCLOCK_IDLE = 0,
  GLOBALCLOCK_INSTANTIATION,
  GLOBALCLOCK_INITIALIZATION,
  GLOBALCLOCK_SIMULATION,
  GLOBALCLOCK_COMMUNICATION,
  GLOBALCLOCK_RESULTFILE,
 
  GLOBALCLOCK_MAX_INDEX
};
 
class Clocks
{
public:
  Clocks(int numSubClocks);
  ~Clocks();
 
  void tic(int clock);
  void toc(int clock);
  void getStats(double* cpuStats, double* wallStats);
 
private:
  int numSubClocks;
  Clock *clocks;
  std::stack<int> activeClocks;
 
private:
  // Stop the compiler generating methods of copy the object
  Clocks(Clocks const& copy);            // Not Implemented
  Clocks& operator=(Clocks const& copy); // Not Implemented
};
 
extern Clocks globalClocks;
extern const char* GlobalClockNames[GLOBALCLOCK_MAX_INDEX];
 
#endif