1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#pragma once
#include <string>
#include <string_view>
#include "frc/Tracer.h"
namespace wpi {
class raw_ostream;
} // namespace wpi
namespace frc {
/**
* A class for keeping track of how much time it takes for different
* parts of code to execute. This class uses RAII, meaning you simply
* need to create an instance at the top of the block you are timing. After the
* block finishes execution (i.e. when the ScopedTracer instance gets
* destroyed), the epoch is printed to the provided raw_ostream.
*/
class ScopedTracer {
public:
/**
* Constructs a ScopedTracer instance.
*
* @param name The name of the epoch.
* @param os A reference to the raw_ostream to print data to.
*/
ScopedTracer(std::string_view name, wpi::raw_ostream& os);
~ScopedTracer();
ScopedTracer(const ScopedTracer&) = delete;
ScopedTracer& operator=(const ScopedTracer&) = delete;
private:
Tracer m_tracer;
std::string m_name;
wpi::raw_ostream& m_os;
};
} // namespace frc