mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-30 02:31:44 +00:00
8f1f64ffb6
Also update copyright to include "and other WPILib contributors" and clarify license referral language to not be restricted to FIRST teams.
46 lines
1.2 KiB
C++
46 lines
1.2 KiB
C++
// 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 <wpi/StringRef.h>
|
|
#include <wpi/Twine.h>
|
|
|
|
#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(wpi::Twine 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
|