stopwatch.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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