TfScriptModuleLoader Class Reference

#include <scriptModuleLoader.h>

Inheritance diagram for TfScriptModuleLoader:

Public Types
typedef TfScriptModuleLoader	This

Public Member Functions
TF_API void	RegisterLibrary (TfToken const &name, TfToken const &moduleName, std::vector< TfToken > const &predecessors)
TF_API void	LoadModules ()
TF_API void	LoadModulesForLibrary (TfToken const &name)
TF_API std::vector< std::string >	GetModuleNames () const
TF_API hboost::python::dict	GetModulesDict () const
TF_API void	WriteDotFile (std::string const &file) const
Public Member Functions inherited from TfWeakBase
	TfWeakBase ()
	TfWeakBase (const TfWeakBase &)
const TfWeakBase &	__GetTfWeakBase__ () const
const TfWeakBase &	operator= (const TfWeakBase &)
void	EnableNotification2 () const
TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions
static TF_API This &	GetInstance ()
	Return the singleton instance. More...

Friends
class	TfSingleton< This >

Additional Inherited Members
Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()
TfRefPtr< Tf_Remnant >	_Register () const
template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const
bool	_HasRemnant () const

Detailed Description

Provides low-level facilities for shared libraries with script bindings to register themselves with their dependences, and provides a mechanism whereby those script modules will be loaded when necessary. Currently, this is when one of our script modules is loaded, when TfPyInitialize is called, and when Plug opens shared libraries.

Generally, user code will not make use of this.

Definition at line 58 of file scriptModuleLoader.h.

Member Typedef Documentation

typedef TfScriptModuleLoader TfScriptModuleLoader::This

Definition at line 62 of file scriptModuleLoader.h.

Member Function Documentation

static TF_API This& TfScriptModuleLoader::GetInstance ( )

inlinestatic

Return the singleton instance.

Definition at line 65 of file scriptModuleLoader.h.

TF_API std::vector<std::string> TfScriptModuleLoader::GetModuleNames

(

)

const

Return a list of all currently known modules in a valid dependency order.

TF_API hboost::python::dict TfScriptModuleLoader::GetModulesDict

(

)

const

Return a python dict containing all currently known modules under their canonical names.

TF_API void TfScriptModuleLoader::LoadModules

(

)

Load all the script modules for any libraries registered using RegisterLibrary if necessary. Loads the modules in dependency order as defined in RegisterLibrary.

TF_API void TfScriptModuleLoader::LoadModulesForLibrary

(

TfToken const &

name

)

Load all the script modules for any libraries registered using RegisterLibrary that depend on library name.

TF_API void TfScriptModuleLoader::RegisterLibrary	(	TfToken const &	name,
		TfToken const &	moduleName,
		std::vector< TfToken > const &	predecessors
	)

Register a library named name and with script module moduleName and libraries which must be loaded first predecessors. The script module will be loaded when necessary. This should generally not be called by user code.

TF_API void TfScriptModuleLoader::WriteDotFile

(

std::string const &

file

)

const

Write a graphviz dot-file for the dependency graph of all. currently known libraries/modules to file.

Friends And Related Function Documentation

friend class TfSingleton< This >

friend

Definition at line 121 of file scriptModuleLoader.h.

---

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

• pxr/base/tf/scriptModuleLoader.h