stopwatch.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_STOPWATCH_H
#define PXR_BASE_TF_STOPWATCH_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/base/arch/timing.h"
#include "pxr/base/tf/api.h"
 
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TfStopwatch
{
public:
 
    inline void Start() {
        _startTick = ArchGetStartTickTime();
    }
 
    inline void Stop() {
        _nTicks += ArchGetStopTickTime() - _startTick;
        _sampleCount++;
    }
 
    void Reset() {
        _nTicks = 0;
        _sampleCount = 0;
    }
 
    void AddFrom(const TfStopwatch& t) {
        _nTicks += t._nTicks;
        _sampleCount += t._sampleCount;
    }
    
    int64_t GetNanoseconds() const {
        return ArchTicksToNanoseconds(_nTicks);
    }
 
    int64_t GetMicroseconds() const {
        return GetNanoseconds() / 1000;
    }
 
    int64_t GetMilliseconds() const {
        return GetMicroseconds() / 1000;
    }
 
    size_t GetSampleCount() const {
        return _sampleCount;
    }
 
    double GetSeconds() const {
        return ArchTicksToSeconds(_nTicks);
    }
 
private:
    uint64_t    _nTicks = 0;
    uint64_t    _startTick = 0;
    size_t      _sampleCount = 0;
};
 
TF_API std::ostream& operator<<(std::ostream& out, const TfStopwatch& s);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_STOPWATCH_H