HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SdfAssetPath Class Reference

#include <assetPath.h>

+ Inheritance diagram for SdfAssetPath:

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::stringGetAssetPath () const
 Return the asset path. More...
 
const std::stringGetResolvedPath () const
 

Friends

void swap (SdfAssetPath &lhs, SdfAssetPath &rhs)
 

Operators

bool operator== (const SdfAssetPath &rhs) const
 Equality, including the resolved path. More...
 
SDF_API bool operator< (const SdfAssetPath &rhs) const
 Ordering first by asset path, then by resolved path. More...
 
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 47 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 111 of file assetPath.h.

size_t SdfAssetPath::GetHash ( ) const
inline

Hash function.

Definition at line 88 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 120 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

Equality, including the resolved path.

Definition at line 79 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 103 of file assetPath.h.

void swap ( SdfAssetPath lhs,
SdfAssetPath rhs 
)
friend

Definition at line 127 of file assetPath.h.


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