SdfAssetPath Class Reference

#include <assetPath.h>

Classes
class	Hash

Public Member Functions
Constructors
SDF_API	SdfAssetPath ()
	Construct an empty asset path. More...
SDF_API	SdfAssetPath (const std::string &path)
SDF_API	SdfAssetPath (const std::string &path, const std::string &resolvedPath)
Accessors
const std::string &	GetAssetPath () const &
	Return the asset path. More...
std::string	GetAssetPath () const &&
	Overload for rvalues, move out the asset path. More...
const std::string &	GetResolvedPath () const &
std::string	GetResolvedPath () const &&
	Overload for rvalues, move out the asset path. More...

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

Operators
bool	operator== (const SdfAssetPath &rhs) const
	Equality, including the resolved path. More...
bool	operator!= (const SdfAssetPath &rhs) const
SDF_API bool	operator< (const SdfAssetPath &rhs) const
	Ordering first by asset path, then by resolved path. More...
bool	operator<= (const SdfAssetPath &rhs) const
bool	operator> (const SdfAssetPath &rhs) const
bool	operator>= (const SdfAssetPath &rhs) const
size_t	GetHash () const
	Hash function. More...
size_t	hash_value (const SdfAssetPath &ap)
	Equality, including the resolved path. More...

Detailed Description

Contains an asset path and an optional resolved path. Asset paths may contain non-control UTF-8 encoded characters. Specifically, U+0000..U+001F (C0 controls), U+007F (delete), and U+0080..U+009F (C1 controls) are disallowed. Attempts to construct asset paths with such characters will issue a TfError and produce the default-constructed empty asset path.

Definition at line 46 of file assetPath.h.

Constructor & Destructor Documentation

SDF_API SdfAssetPath::SdfAssetPath

(

)

Construct an empty asset path.

SDF_API SdfAssetPath::SdfAssetPath ( const std::string &  path )

explicit

Construct an asset path with path and no associated resolved path.

If the passed path is not valid UTF-8 or contains C0 or C1 control characters, raise a TfError and return the default-constructed empty asset path.

SDF_API SdfAssetPath::SdfAssetPath	(	const std::string &	path,
		const std::string &	resolvedPath
	)

Construct an asset path with path and an associated resolvedPath.

If either the passed or resolvedPath are not valid UTF-8 or either contain C0 or C1 control characters, raise a TfError and return the default-constructed empty asset path.

Member Function Documentation

const std::string& SdfAssetPath::GetAssetPath ( ) const

inline

Return the asset path.

Definition at line 130 of file assetPath.h.

std::string SdfAssetPath::GetAssetPath ( ) const

inline

Overload for rvalues, move out the asset path.

Definition at line 135 of file assetPath.h.

size_t SdfAssetPath::GetHash ( ) const

inline

Hash function.

Definition at line 110 of file assetPath.h.

const std::string& SdfAssetPath::GetResolvedPath ( ) const

inline

Return the resolved asset path, if any.

Note that SdfAssetPath carries a resolved path only if its creator passed one to the constructor. SdfAssetPath never performs resolution itself.

Definition at line 144 of file assetPath.h.

std::string SdfAssetPath::GetResolvedPath ( ) const

inline

Overload for rvalues, move out the asset path.

Definition at line 149 of file assetPath.h.

bool SdfAssetPath::operator!= ( const SdfAssetPath &  rhs ) const

inline

Inequality operator

See Also

SdfAssetPath::operator==(const SdfAssetPath&)

Definition at line 84 of file assetPath.h.

SDF_API bool SdfAssetPath::operator<

(

const SdfAssetPath &

rhs

)

const

Ordering first by asset path, then by resolved path.

bool SdfAssetPath::operator<= ( const SdfAssetPath &  rhs ) const

inline

Less than or equal operator

See Also

SdfAssetPath::operator<(const SdfAssetPath&)

Definition at line 93 of file assetPath.h.

bool SdfAssetPath::operator== ( const SdfAssetPath &  rhs ) const

inline

Equality, including the resolved path.

Definition at line 77 of file assetPath.h.

bool SdfAssetPath::operator> ( const SdfAssetPath &  rhs ) const

inline

Greater than operator

See Also

SdfAssetPath::operator<(const SdfAssetPath&)

Definition at line 99 of file assetPath.h.

bool SdfAssetPath::operator>= ( const SdfAssetPath &  rhs ) const

inline

Greater than or equal operator

See Also

SdfAssetPath::operator<(const SdfAssetPath&)

Definition at line 105 of file assetPath.h.

Friends And Related Function Documentation

size_t hash_value ( const SdfAssetPath &  ap )

friend

Equality, including the resolved path.

Definition at line 122 of file assetPath.h.

void swap ( SdfAssetPath &  lhs, SdfAssetPath &  rhs  )

friend

Definition at line 156 of file assetPath.h.

---

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

• pxr/usd/sdf/assetPath.h