cache element class used to represent an Usd asset in cache for the resolver More...

#include <assetIdentDef.h>

Collaboration diagram for assetIdent:

Public Member Functions
	assetIdent ()

	assetIdent (bool is_static)

	assetIdent (const std::string &assetIdentifier)

	assetIdent (const ArResolvedPath &path, const std::string &identifier, bool is_static)

ArResolvedPath	getResolvedAssetPath () const
	returns the ResolvedAssetPath for this assetIdent More...

bool	setResolvedAssetPath (const ArResolvedPath &inResolvedAssetPath)
	allows setting the ResolvedAssetPath More...

bool	setResolvedAssetPath (const std::string &inResolvedAssetPath)

std::string	getAssetIdentifier () const
	returns the asset identifier More...

bool	setAssetIdentifier (const std::string inAssetIdentifier)
	allows you to set the internal m_assetIdentifier More...

bool	is_empty () const
	can be used to know if given assetIdent has data in it More...

bool	is_valid () const
	this function allows you to know if an given assetIdent's cache is still valid. More...

void	invalidate ()
	allows you to invalidate this assetIdent. More...

void	validate ()
	allows you to validate this assetIdent. More...

bool	is_modifiable () const
	allows you to know if you can modify the data in this assetIdent it is also used in getAssetIdentifier and getResolvedAssetPath to keep you from modifying data you should not touch. More...

void	printInfo () const
	this function will print out all debug info about this assetIdent instance More...

bool	operator== (const assetIdent &other) const

assetIdent &	operator= (const assetIdent &other)

	assetIdent ()

	assetIdent (bool is_static)

	assetIdent (const std::string &assetIdentifier)

	assetIdent (const ArResolvedPath &path, const std::string &identifier, bool is_static)

ArResolvedPath	getResolvedAssetPath () const
	returns the ResolvedAssetPath for this assetIdent More...

bool	setResolvedAssetPath (const ArResolvedPath &inResolvedAssetPath)
	allows setting the ResolvedAssetPath More...

bool	setResolvedAssetPath (const std::string &inResolvedAssetPath)

std::string	getAssetIdentifier () const
	returns the asset identifier More...

bool	setAssetIdentifier (const std::string inAssetIdentifier)
	allows you to set the internal m_assetIdentifier More...

bool	is_empty () const
	can be used to know if given assetIdent has data in it More...

bool	is_valid () const
	this function allows you to know if an given assetIdent's cache is still valid. More...

void	invalidate ()
	allows you to invalidate this assetIdent. More...

void	validate ()
	allows you to validate this assetIdent. More...

bool	is_modifiable () const
	allows you to know if you can modify the data in this assetIdent it is also used in getAssetIdentifier and getResolvedAssetPath to keep you from modifying data you should not touch. More...

void	printInfo () const
	this function will print out all debug info about this assetIdent instance More...

bool	operator== (const assetIdent &other) const

assetIdent &	operator= (const assetIdent &other)

Private Attributes
const bool	m_static

bool	m_invalidated

ArResolvedPath	m_resolvedAssetPath

std::string	m_assetIdentifier

Detailed Description

cache element class used to represent an Usd asset in cache for the resolver

Parameters

is_static

Returns

Constructor & Destructor Documentation

◆ assetIdent() [1/8]

assetIdent::assetIdent ( )

inline

◆ assetIdent() [2/8]

assetIdent::assetIdent ( bool is_static )

inline

◆ assetIdent() [3/8]

assetIdent::assetIdent ( const std::string & assetIdentifier )

inline

◆ assetIdent() [4/8]

assetIdent::assetIdent	(	const ArResolvedPath &	path,
		const std::string &	identifier,
		bool	is_static
	)

inline

◆ assetIdent() [5/8]

assetIdent::assetIdent ( )

inline

◆ assetIdent() [6/8]

assetIdent::assetIdent ( bool is_static )

inline

◆ assetIdent() [7/8]

assetIdent::assetIdent ( const std::string & assetIdentifier )

inline

◆ assetIdent() [8/8]

assetIdent::assetIdent	(	const ArResolvedPath &	path,
		const std::string &	identifier,
		bool	is_static
	)

inline

Member Function Documentation

◆ getAssetIdentifier() [1/2]

std::string assetIdent::getAssetIdentifier ( ) const

returns the asset identifier

Here is the caller graph for this function:

◆ getAssetIdentifier() [2/2]

std::string assetIdent::getAssetIdentifier ( ) const

returns the asset identifier

◆ getResolvedAssetPath() [1/2]

PXR_NAMESPACE_USING_DIRECTIVE ArResolvedPath assetIdent::getResolvedAssetPath ( ) const

returns the ResolvedAssetPath for this assetIdent

Returns: Pxr ArResolvedPath

Here is the caller graph for this function:

◆ getResolvedAssetPath() [2/2]

ArResolvedPath assetIdent::getResolvedAssetPath ( ) const

returns the ResolvedAssetPath for this assetIdent

Returns: Pxr ArResolvedPath

◆ invalidate() [1/2]

void assetIdent::invalidate ( )

allows you to invalidate this assetIdent.

It is not possible to invalidate an assetIdent that is not modifiable in this case the function will simply return

Here is the call graph for this function:

◆ invalidate() [2/2]

void assetIdent::invalidate ( )

allows you to invalidate this assetIdent.

It is not possible to invalidate an assetIdent that is not modifiable in this case the function will simply return

◆ is_empty() [1/2]

bool assetIdent::is_empty ( ) const

can be used to know if given assetIdent has data in it

Returns: bool: true if neither m_resolvedAssetPath or m_assetIdentifier have any data in them

Here is the caller graph for this function:

◆ is_empty() [2/2]

bool assetIdent::is_empty ( ) const

can be used to know if given assetIdent has data in it

Returns: bool: true if neither m_resolvedAssetPath or m_assetIdentifier have any data in them

◆ is_modifiable() [1/2]

bool assetIdent::is_modifiable ( ) const

allows you to know if you can modify the data in this assetIdent it is also used in getAssetIdentifier and getResolvedAssetPath to keep you from modifying data you should not touch.

This will be the case if this assetIdent is marked as static

Returns: true if you are allowed to modify the assetIdent, false if the modification is not allowed for what ever reason

Here is the caller graph for this function:

◆ is_modifiable() [2/2]

bool assetIdent::is_modifiable ( ) const

allows you to know if you can modify the data in this assetIdent it is also used in getAssetIdentifier and getResolvedAssetPath to keep you from modifying data you should not touch.

This will be the case if this assetIdent is marked as static

Returns: true if you are allowed to modify the assetIdent, false if the modification is not allowed for what ever reason

◆ is_valid() [1/2]

bool assetIdent::is_valid ( ) const

this function allows you to know if an given assetIdent's cache is still valid.

This can be use full for TTL or cache invalidation as we use lazy reaching for cached objects

Returns: true if the current data can safely be used. false if the data is out of data or should in be re-cached

◆ is_valid() [2/2]

bool assetIdent::is_valid ( ) const

this function allows you to know if an given assetIdent's cache is still valid.

This can be use full for TTL or cache invalidation as we use lazy reaching for cached objects

Returns: true if the current data can safely be used. false if the data is out of data or should in be re-cached

◆ operator=() [1/2]

assetIdent & assetIdent::operator= ( const assetIdent & other )

◆ operator=() [2/2]

assetIdent & assetIdent::operator= ( const assetIdent & other )

◆ operator==() [1/2]

bool assetIdent::operator== ( const assetIdent & other ) const

◆ operator==() [2/2]

bool assetIdent::operator== ( const assetIdent & other ) const

◆ printInfo() [1/2]

void assetIdent::printInfo ( ) const

this function will print out all debug info about this assetIdent instance

◆ printInfo() [2/2]

void assetIdent::printInfo ( ) const

this function will print out all debug info about this assetIdent instance

◆ setAssetIdentifier() [1/2]

bool assetIdent::setAssetIdentifier ( const std::string inAssetIdentifier )

allows you to set the internal m_assetIdentifier

Parameters

assetIdentifier

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAssetIdentifier() [2/2]

bool assetIdent::setAssetIdentifier ( const std::string inAssetIdentifier )

allows you to set the internal m_assetIdentifier

Parameters

assetIdentifier

Returns

◆ setResolvedAssetPath() [1/4]

bool assetIdent::setResolvedAssetPath ( const ArResolvedPath & inResolvedAssetPath )

allows setting the ResolvedAssetPath

Parameters

inResolvedAssetPath

Returns: false if assetIdent can't be modified (eg. is_valid)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setResolvedAssetPath() [2/4]

bool assetIdent::setResolvedAssetPath ( const ArResolvedPath & inResolvedAssetPath )

allows setting the ResolvedAssetPath

Parameters

inResolvedAssetPath

Returns: false if assetIdent can't be modified (eg. is_valid)

◆ setResolvedAssetPath() [3/4]

bool assetIdent::setResolvedAssetPath ( const std::string & inResolvedAssetPath )

Here is the call graph for this function:

◆ setResolvedAssetPath() [4/4]

bool assetIdent::setResolvedAssetPath ( const std::string & inResolvedAssetPath )

◆ validate() [1/2]

void assetIdent::validate ( )

allows you to validate this assetIdent.

This function will return while doing nothing if is_modifiable returns false

Here is the call graph for this function:

◆ validate() [2/2]

void assetIdent::validate ( )

allows you to validate this assetIdent.

This function will return while doing nothing if is_modifiable returns false

Member Data Documentation

◆ m_assetIdentifier

std::string assetIdent::m_assetIdentifier

private

◆ m_invalidated

bool assetIdent::m_invalidated

private

◆ m_resolvedAssetPath

ArResolvedPath assetIdent::m_resolvedAssetPath

private

◆ m_static

const bool assetIdent::m_static

private

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

/github/workspace/src/AyonUsdResolver/assetIdentDef.h
/github/workspace/src/AyonUsdResolver/cache/assetIdentDef.h
/github/workspace/src/AyonUsdResolver/assetIdentDef.cpp
/github/workspace/src/AyonUsdResolver/cache/assetIdentDef.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ assetIdent() [1/8]

◆ assetIdent() [2/8]

◆ assetIdent() [3/8]

◆ assetIdent() [4/8]

◆ assetIdent() [5/8]

◆ assetIdent() [6/8]

◆ assetIdent() [7/8]

◆ assetIdent() [8/8]

Member Function Documentation

◆ getAssetIdentifier() [1/2]

◆ getAssetIdentifier() [2/2]

◆ getResolvedAssetPath() [1/2]

◆ getResolvedAssetPath() [2/2]

◆ invalidate() [1/2]

◆ invalidate() [2/2]

◆ is_empty() [1/2]

◆ is_empty() [2/2]

◆ is_modifiable() [1/2]

◆ is_modifiable() [2/2]

◆ is_valid() [1/2]

◆ is_valid() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ printInfo() [1/2]

◆ printInfo() [2/2]

◆ setAssetIdentifier() [1/2]

◆ setAssetIdentifier() [2/2]

◆ setResolvedAssetPath() [1/4]

◆ setResolvedAssetPath() [2/4]

◆ setResolvedAssetPath() [3/4]

◆ setResolvedAssetPath() [4/4]

◆ validate() [1/2]

◆ validate() [2/2]

Member Data Documentation

◆ m_assetIdentifier

◆ m_invalidated

◆ m_resolvedAssetPath

◆ m_static