GfTimeCode Class Reference

Value type that represents a time code. More...

#include <timeCode.h>

Public Member Functions
Constructors
constexpr	GfTimeCode (double time=0.0) noexcept
	Construct a time code with the given time.
Accessors
constexpr double	GetValue () const noexcept
	Return the time value.

Friends
void	swap (GfTimeCode &lhs, GfTimeCode &rhs)

Operators
constexpr bool	operator== (const GfTimeCode &rhs) const noexcept
constexpr bool	operator!= (const GfTimeCode &rhs) const noexcept
constexpr bool	operator< (const GfTimeCode &rhs) const noexcept
constexpr bool	operator> (const GfTimeCode &rhs) const noexcept
constexpr bool	operator<= (const GfTimeCode &rhs) const noexcept
constexpr bool	operator>= (const GfTimeCode &rhs) const noexcept
constexpr GfTimeCode	operator* (const GfTimeCode &rhs) const noexcept
constexpr GfTimeCode	operator/ (const GfTimeCode &rhs) const noexcept
constexpr GfTimeCode	operator+ (const GfTimeCode &rhs) const noexcept
constexpr GfTimeCode	operator- (const GfTimeCode &rhs) const noexcept
constexpr GfTimeCode	operator- () const noexcept
constexpr	operator double () const noexcept
	Explicit conversion to double.
size_t	GetHash () const
	Hash function.
size_t	hash_value (const GfTimeCode &ap)

Detailed Description

Value type that represents a time code.

It's equivalent to a double type value but is used to indicate that this value should be resolved by any time based value resolution.

Definition at line 27 of file timeCode.h.

Constructor & Destructor Documentation

GfTimeCode()

GfTimeCode ( double time = 0.0 )

inlineconstexprnoexcept

Construct a time code with the given time.

A default constructed GfTimeCode has a time of 0.0. A double value can implicitly cast to GfTimeCode.

Definition at line 37 of file timeCode.h.

Member Function Documentation

GetHash()

size_t GetHash ( ) const

inline

Hash function.

Definition at line 72 of file timeCode.h.

GetValue()

double GetValue ( ) const

inlineconstexprnoexcept

Return the time value.

Definition at line 92 of file timeCode.h.

operator double()

operator double ( ) const

inlineexplicitconstexprnoexcept

Explicit conversion to double.

Definition at line 69 of file timeCode.h.

operator!=()

bool operator!= ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 46 of file timeCode.h.

operator*()

GfTimeCode operator* ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 57 of file timeCode.h.

operator+()

GfTimeCode operator+ ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 61 of file timeCode.h.

operator-() [1/2]

GfTimeCode operator- ( ) const

inlineconstexprnoexcept

Definition at line 65 of file timeCode.h.

operator-() [2/2]

GfTimeCode operator- ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 63 of file timeCode.h.

operator/()

GfTimeCode operator/ ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 59 of file timeCode.h.

operator<()

bool operator< ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 48 of file timeCode.h.

operator<=()

bool operator<= ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 52 of file timeCode.h.

operator==()

bool operator== ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 44 of file timeCode.h.

operator>()

bool operator> ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 50 of file timeCode.h.

operator>=()

bool operator>= ( const GfTimeCode & rhs ) const

inlineconstexprnoexcept

Definition at line 54 of file timeCode.h.

Friends And Related Symbol Documentation

hash_value

size_t hash_value ( const GfTimeCode & ap )

friend

Definition at line 84 of file timeCode.h.

swap

void swap ( GfTimeCode & lhs, GfTimeCode & rhs )

friend

Definition at line 99 of file timeCode.h.

---

The documentation for this class was generated from the following file:

• pxr/base/gf/timeCode.h