SdfTimeCode Class Reference

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

#include <timeCode.h>

Public Member Functions
Constructors
constexpr	SdfTimeCode (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 (SdfTimeCode &lhs, SdfTimeCode &rhs)

Operators
constexpr bool	operator== (const SdfTimeCode &rhs) const noexcept
constexpr bool	operator!= (const SdfTimeCode &rhs) const noexcept
constexpr bool	operator< (const SdfTimeCode &rhs) const noexcept
constexpr bool	operator> (const SdfTimeCode &rhs) const noexcept
constexpr bool	operator<= (const SdfTimeCode &rhs) const noexcept
constexpr bool	operator>= (const SdfTimeCode &rhs) const noexcept
constexpr SdfTimeCode	operator* (const SdfTimeCode &rhs) const noexcept
constexpr SdfTimeCode	operator/ (const SdfTimeCode &rhs) const noexcept
constexpr SdfTimeCode	operator+ (const SdfTimeCode &rhs) const noexcept
constexpr SdfTimeCode	operator- (const SdfTimeCode &rhs) const noexcept
constexpr	operator double () const noexcept
	Explicit conversion to double.
size_t	GetHash () const
	Hash function.
size_t	hash_value (const SdfTimeCode &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 28 of file timeCode.h.

Constructor & Destructor Documentation

SdfTimeCode()

constexpr SdfTimeCode ( double  time = 0.0 )

inlineconstexprnoexcept

Construct a time code with the given time.

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

Definition at line 38 of file timeCode.h.

Member Function Documentation

GetHash()

size_t GetHash ( ) const

inline

Hash function.

Definition at line 71 of file timeCode.h.

GetValue()

constexpr double GetValue ( ) const

inlineconstexprnoexcept

Return the time value.

Definition at line 91 of file timeCode.h.

operator double()

constexpr operator double ( ) const

inlineexplicitconstexprnoexcept

Explicit conversion to double.

Definition at line 68 of file timeCode.h.

operator!=()

constexpr bool operator!= ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 47 of file timeCode.h.

operator*()

constexpr SdfTimeCode operator* ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 58 of file timeCode.h.

operator+()

constexpr SdfTimeCode operator+ ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 62 of file timeCode.h.

operator-()

constexpr SdfTimeCode operator- ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 64 of file timeCode.h.

operator/()

constexpr SdfTimeCode operator/ ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 60 of file timeCode.h.

operator<()

constexpr bool operator< ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 49 of file timeCode.h.

operator<=()

constexpr bool operator<= ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 53 of file timeCode.h.

operator==()

constexpr bool operator== ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 45 of file timeCode.h.

operator>()

constexpr bool operator> ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 51 of file timeCode.h.

operator>=()

constexpr bool operator>= ( const SdfTimeCode &  rhs ) const

inlineconstexprnoexcept

Definition at line 55 of file timeCode.h.

Friends And Related Function Documentation

hash_value

size_t hash_value ( const SdfTimeCode &  ap )

friend

Definition at line 83 of file timeCode.h.

swap

void swap ( SdfTimeCode &  lhs, SdfTimeCode &  rhs  )

friend

Definition at line 98 of file timeCode.h.

---

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

• pxr/usd/sdf/timeCode.h