This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ArResolvedPath Class Reference

Represents a resolved asset path. More...

#include <resolvedPath.h>

Public Member Functions

 ArResolvedPath (const std::string &resolvedPath)
 Construct an ArResolvedPath holding the given resolvedPath.
 
 ArResolvedPath (std::string &&resolvedPath)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
 ArResolvedPath (const ArResolvedPath &rhs)=default
 
 ArResolvedPath (ArResolvedPath &&rhs)=default
 
ArResolvedPathoperator= (const ArResolvedPath &rhs)=default
 
ArResolvedPathoperator= (ArResolvedPath &&rhs)=default
 
bool operator== (const ArResolvedPath &rhs) const
 
bool operator!= (const ArResolvedPath &rhs) const
 
bool operator< (const ArResolvedPath &rhs) const
 
bool operator> (const ArResolvedPath &rhs) const
 
bool operator<= (const ArResolvedPath &rhs) const
 
bool operator>= (const ArResolvedPath &rhs) const
 
bool operator== (const std::string &rhs) const
 
bool operator!= (const std::string &rhs) const
 
bool operator< (const std::string &rhs) const
 
bool operator> (const std::string &rhs) const
 
bool operator<= (const std::string &rhs) const
 
bool operator>= (const std::string &rhs) const
 
size_t GetHash () const
 Return hash value for this object.
 
 operator bool () const
 Return true if this object is holding a non-empty resolved path, false otherwise.
 
bool IsEmpty () const
 Return true if this object is holding an empty resolved path, false otherwise.
 
bool empty () const
 Equivalent to IsEmpty.
 
 operator const std::string & () const
 Return the resolved path held by this object as a string.
 
const std::string & GetPathString () const
 Return the resolved path held by this object as a string.
 

Detailed Description

Represents a resolved asset path.

Definition at line 22 of file resolvedPath.h.

Constructor & Destructor Documentation

◆ ArResolvedPath() [1/2]

ArResolvedPath ( const std::string &  resolvedPath)
inlineexplicit

Construct an ArResolvedPath holding the given resolvedPath.

Definition at line 26 of file resolvedPath.h.

◆ ArResolvedPath() [2/2]

ArResolvedPath ( std::string &&  resolvedPath)
inlineexplicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 32 of file resolvedPath.h.

Member Function Documentation

◆ empty()

bool empty ( ) const
inline

Equivalent to IsEmpty.

This exists primarily for backwards compatibility.

Definition at line 94 of file resolvedPath.h.

◆ GetHash()

size_t GetHash ( ) const
inline

Return hash value for this object.

Definition at line 82 of file resolvedPath.h.

◆ GetPathString()

const std::string & GetPathString ( ) const
inline

Return the resolved path held by this object as a string.

Definition at line 100 of file resolvedPath.h.

◆ IsEmpty()

bool IsEmpty ( ) const
inline

Return true if this object is holding an empty resolved path, false otherwise.

Definition at line 90 of file resolvedPath.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Return true if this object is holding a non-empty resolved path, false otherwise.

Definition at line 86 of file resolvedPath.h.

◆ operator const std::string &()

operator const std::string & ( ) const
inline

Return the resolved path held by this object as a string.

Definition at line 97 of file resolvedPath.h.

◆ operator!=() [1/2]

bool operator!= ( const ArResolvedPath rhs) const
inline

Definition at line 48 of file resolvedPath.h.

◆ operator!=() [2/2]

bool operator!= ( const std::string &  rhs) const
inline

Definition at line 66 of file resolvedPath.h.

◆ operator<() [1/2]

bool operator< ( const ArResolvedPath rhs) const
inline

Definition at line 51 of file resolvedPath.h.

◆ operator<() [2/2]

bool operator< ( const std::string &  rhs) const
inline

Definition at line 69 of file resolvedPath.h.

◆ operator<=() [1/2]

bool operator<= ( const ArResolvedPath rhs) const
inline

Definition at line 57 of file resolvedPath.h.

◆ operator<=() [2/2]

bool operator<= ( const std::string &  rhs) const
inline

Definition at line 75 of file resolvedPath.h.

◆ operator==() [1/2]

bool operator== ( const ArResolvedPath rhs) const
inline

Definition at line 45 of file resolvedPath.h.

◆ operator==() [2/2]

bool operator== ( const std::string &  rhs) const
inline

Definition at line 63 of file resolvedPath.h.

◆ operator>() [1/2]

bool operator> ( const ArResolvedPath rhs) const
inline

Definition at line 54 of file resolvedPath.h.

◆ operator>() [2/2]

bool operator> ( const std::string &  rhs) const
inline

Definition at line 72 of file resolvedPath.h.

◆ operator>=() [1/2]

bool operator>= ( const ArResolvedPath rhs) const
inline

Definition at line 60 of file resolvedPath.h.

◆ operator>=() [2/2]

bool operator>= ( const std::string &  rhs) const
inline

Definition at line 78 of file resolvedPath.h.


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