duration.h

Go to the documentation of this file.

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_DURATION_H
#define PXR_BASE_GF_DURATION_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/api.h"
 
#include <functional>
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfDuration
{
public:
 
    constexpr GfDuration(double duration = 0.0) noexcept : _duration(duration) {};
 
 
 
    friend constexpr bool operator==(const GfDuration &lhs,
                                     const GfDuration &rhs) noexcept
        { return lhs._duration == rhs._duration; }
    friend constexpr bool operator!=(const GfDuration &lhs,
                                     const GfDuration &rhs) noexcept
        { return lhs._duration != rhs._duration; }
    friend constexpr bool operator<(const GfDuration &lhs,
                                    const GfDuration &rhs) noexcept
        { return lhs._duration < rhs._duration; }
    friend constexpr bool operator>(const GfDuration &lhs,
                                    const GfDuration &rhs) noexcept
        { return lhs._duration > rhs._duration; }
    friend constexpr bool operator<=(const GfDuration &lhs,
                                     const GfDuration &rhs) noexcept
        { return lhs._duration <= rhs._duration; }
    friend constexpr bool operator>=(const GfDuration &lhs,
                                     const GfDuration &rhs) noexcept
        { return lhs._duration >= rhs._duration; }
 
    friend constexpr
    GfDuration operator*(const GfDuration& d,
                         const double amount) noexcept
        { return GfDuration(d._duration * amount); }
    friend constexpr
    GfDuration operator*(const double amount,
                         const GfDuration& d) noexcept
        { return GfDuration(amount * d._duration); }
    friend constexpr
    GfDuration operator/(const GfDuration& d,
                         const double amount) noexcept
        { return GfDuration(d._duration / amount); }
 
    constexpr double operator/(const GfDuration &rhs) const noexcept
        { return (_duration / rhs._duration); }
 
    friend constexpr
    GfDuration operator+(const GfDuration& lhs,
                         const GfDuration& rhs) noexcept
        { return GfDuration(lhs._duration + rhs._duration); }
    friend constexpr
    GfDuration operator-(const GfDuration& lhs,
                         const GfDuration& rhs) noexcept
        { return GfDuration(lhs._duration - rhs._duration); }
    constexpr GfDuration operator-() const noexcept
        { return GfDuration(-_duration); }
 
    explicit constexpr operator double() const noexcept {return _duration;}
 
    size_t GetHash() const {
        return std::hash<double>()(_duration);
    }
 
    struct Hash
    {
        size_t operator()(const GfDuration& ap) const {
            return ap.GetHash();
        }
    };
 
    friend size_t hash_value(const GfDuration& ap) { return ap.GetHash(); }
 
    template <class HashState>
    friend void TfHashAppend(HashState &h, const GfDuration& d)
    {
        // Delegate to TfHashAppend(HashState, double)
        TfHashAppend(h, d._duration);
    }
 
 
 
    constexpr double GetValue() const noexcept {
        return _duration;
    }
 
 
private:
    friend inline void swap(GfDuration &lhs, GfDuration &rhs) {
        std::swap(lhs._duration, rhs._duration);
    }
 
    double _duration;
};
 
 
GF_API std::ostream& operator<<(std::ostream& out, const GfDuration& duration);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_DURATION_H