WSF
ProfilingRegion.hpp
Go to the documentation of this file.
1// ****************************************************************************
2// CUI
3//
4// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
5//
6// Copyright (C) 2021 Stellar Science; U.S. Government has Unlimited Rights.
7//
8// The use, dissemination or disclosure of data in this file is subject to
9// limitation or restriction. See accompanying README and LICENSE for details.
10// ****************************************************************************
11
12#ifndef PROFILINGREGION_HPP
13#define PROFILINGREGION_HPP
14
16
17#include "profiling_export.h"
18
19#include <cstdint>
20
21namespace profiling
22{
23
96class PROFILING_EXPORT ProfilingRegion
97{
98public:
102 ProfilingRegion(const char aRegionLabel[]);
105
106 ProfilingRegion() = delete;
111};
112
142PROFILING_EXPORT uint32_t CreateProfilingSection(const char label[]);
143
150PROFILING_EXPORT void DestroyProfilingSection(uint32_t sectionId);
151
163PROFILING_EXPORT void BeginProfilingSection(uint32_t sectionId);
164
174PROFILING_EXPORT void EndProfilingSection(uint32_t sectionId);
175
176} // namespace profiling
177
178#endif // PROFILINGREGION_HPP
ProfilingRegion(const char aRegionLabel[])
Begin a profiling region.
Definition ProfilingRegion.cpp:26
ProfilingRegion(ProfilingRegion &&)=delete
ProfilingRegion & operator=(ProfilingRegion &&)=delete
ProfilingRegion(const ProfilingRegion &)=delete
ProfilingRegion & operator=(const ProfilingRegion &)=delete
Definition of utility struct and function used by the profiling targets.
Definition ProfilingCommon.hpp:23
void EndProfilingSection(uint32_t sectionId)
End a previously created and begun profiling section.
Definition ProfilingRegion.cpp:77
void DestroyProfilingSection(uint32_t sectionId)
Destroy a profiling section that was created by CreateProfilingSection.
Definition ProfilingRegion.cpp:59
void BeginProfilingSection(uint32_t sectionId)
Begin a previously created profiling section.
Definition ProfilingRegion.cpp:68
uint32_t CreateProfilingSection(const char label[])
Create a profiling section.
Definition ProfilingRegion.cpp:45
Copyrights Multiple, All Rights Reserved