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

Contains an asset path and an optional resolved path. More...

Inherits totally_ordered< SdfAssetPath >.

Public Member Functions

Constructors
SDF_API SdfAssetPath ()
 Construct an empty asset path. More...
 
SDF_API SdfAssetPath (const std::string &path)
 Construct asset path with no associated resolved path. More...
 
SDF_API SdfAssetPath (const std::string &path, const std::string &resolvedPath)
 Construct an asset path with an associated resolved path. More...
 
Accessors
const std::string & GetAssetPath () const
 Return the asset path. More...
 
const std::string & GetResolvedPath () const
 Return the resolved asset path, if any. More...
 

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)
 

Detailed Description

Contains an asset path and an optional resolved path.

Definition at line 43 of file assetPath.h.

Constructor & Destructor Documentation

SDF_API SdfAssetPath ( )

Construct an empty asset path.

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

Construct asset path with no associated resolved path.

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

Construct an asset path with an associated resolved path.

Member Function Documentation

const std::string& GetAssetPath ( ) const
inline

Return the asset path.

Definition at line 98 of file assetPath.h.

size_t GetHash ( ) const
inline

Hash function.

Definition at line 75 of file assetPath.h.

const std::string& GetResolvedPath ( ) const
inline

Return the resolved asset path, if any.

Note that SdfAssetPath only carries a resolved path if the creator of an instance supplied one to the constructor. SdfAssetPath will never perform any resolution itself.

Definition at line 107 of file assetPath.h.

SDF_API bool operator< ( const SdfAssetPath rhs) const

Ordering first by asset path, then by resolved path.

bool operator== ( const SdfAssetPath rhs) const
inline

Equality, including the resolved path.

Definition at line 66 of file assetPath.h.


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