#include <PDG_TypeRegistry.h>

Inheritance diagram for PDG_TypeRegistry:

Public Member Functions
	~PDG_TypeRegistry () override
	Destructor. More...

template<typename ClassType , typename... Args>
PDG_WorkItemDataType *	registerCustomWorkItemData (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)
	Registers a function-based work item type. More...

template<typename ClassType , typename... Args>
PDG_NodeCallbackType *	registerCustomNodeCallback (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)
	Registers a function-based node type. More...

template<typename ClassType , typename... Args>
PDG_SchedulerType *	registerCustomScheduler (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)
	Registers a function-based scheduler type. More...

template<typename ClassType , typename... Args>
PDG_DependencyType *	registerCustomDependency (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)
	Registers a function-based dependency type. More...

template<typename ClassType , typename... Args>
PDG_ServiceType *	registerCustomService (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)
	Registers a function-based service type. More...

template<typename ClassType >
PDG_DependencyType *	registerDependency (const UT_StringHolder &name, const UT_StringHolder &label)
	Utility method to register a custom C++-based external dependency. More...

template<typename ClassType >
PDG_WorkItemDataType *	registerWorkItemData (const UT_StringHolder &name, const UT_StringHolder &label, bool compatible=true, bool make_default=false)
	Utility method to regiser a custom C++-based work item data. More...

template<typename ClassType >
PDG_SchedulerType *	registerScheduler (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &parm_category, const UT_StringHolder &node_category)
	Utility method to registers a C++-based scheduler node. More...

template<typename ClassType >
PDG_SchedulerType *	registerScheduler (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &parm_category, const UT_StringHolder &node_category, const PDG_NodeInterface &interface)

PDG_ServiceType *	registerService (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &commandline, bool internal)

template<typename ClassType >
PDG_NodeCallbackType *	registerProcessor (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &category, const PDG_NodeInterface &interface, PDG_NodeSubtype sub=PDG_NodeSubtype::eRegular)

template<typename ClassType >
PDG_NodeCallbackType *	registerPartitioner (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &category, const PDG_NodeInterface &interface, PDG_NodeSubtype sub=PDG_NodeSubtype::eRegular)

template<typename ClassType >
PDG_NodeCallbackType *	registerMapper (const UT_StringHolder &name, const UT_StringHolder &label, const UT_StringHolder &category, const PDG_NodeInterface &interface)

PDG_DependencyType *	dependencyType (const UT_StringHolder &name) const
	Returns an external dependency type object for a given name. More...

PDG_NodeCallbackType *	nodeCallbackType (const UT_StringHolder &name) const
	Retruns a node callback type object for a given name. More...

PDG_SchedulerType *	schedulerType (const UT_StringHolder &name) const
	Returns a scheduler type object for a give name. More...

PDG_ServiceType *	serviceType (const UT_StringHolder &name) const
	Returns a service type object for a given name. More...

PDG_WorkItemDataType *	workItemDataType (const UT_StringHolder &name) const
	Returns a work item data type object for a given name. More...

PDG_WorkItemDataType *	defaultWorkItemDataType () const
	Gets/sets the default work item data type. More...

void	setDefaultWorkItemDataType (PDG_WorkItemDataType *type)

PDG_SchedulerType *	serviceSchedulerType () const
	Gets/sets the service scheduler type. More...

void	setServiceSchedulerType (PDG_SchedulerType *type)

PDG_SchedulerType *	inProcessSchedulerType () const
	Gets/sets the in process scheduler type. More...

void	setInProcessSchedulerType (PDG_SchedulerType *type)

const UT_StringHolder &	localSchedulerTypeName () const
	Returns the name of the local scheduler type. More...

PDG_CustomHandlers *	customHandlers ()
	Returns the custom handlers table. More...

PDG_FileUtils *	fileUtils ()
	Returns the shared file utilities object. More...

UT_StringHolder	pySerializationModule () const

void	setPySerializationModule (const UT_StringHolder &mod)
	Sets the custom serialization module name. More...

Public Member Functions inherited from PDGT_TypeRegistry< PDG_RegistrationType,(int) PDG_RegistrationType::eCount >
virtual	~PDGT_TypeRegistry ()

bool	standardInit (UT_WorkBuffer &errors, bool skip_python=false)

void	clear ()
	Clears and deletes everything in the type registry. More...

void	setRegistrationEnabled (bool enabled)
	Enables or disables custom type registration. More...

RegType *	registerType (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)

RegType *	registerFuncType (UT_WorkBuffer &errors, const UT_StringHolder &name, typename RegType::Function func, Args &&...args)

RegType *	registerSimpleType (UT_WorkBuffer &errors, const UT_StringHolder &name, Args &&...args)

bool	registerTypeAlias (PDG_RegistrationTypetype, const UT_StringHolder &name, const UT_StringHolder &alias, bool deprecated=false)
	Registers an alias for an existing type. More...

bool	addParentTypes (BaseType *type, const UT_StringArray &parent_names, UT_WorkBuffer &errors)
	Adds parent types to the type object. More...

bool	addParentType (BaseType type, BaseType parent, UT_WorkBuffer &errors)
	Directly adds a parent type, if it's valid. More...

bool	registerDSOTypes (const UT_StringHolder &dso_path)
	Loads and registers types compiled as a shared library. More...

bool	registerDSOTypes ()

bool	registerPythonModules (UT_WorkBuffer &errors)
	Registers all Python types on the PDG/types search path. More...

bool	registerPythonPath (const UT_StringHolder &path, UT_WorkBuffer &errors)
	Registers a Python module by absolute path. More...

bool	reloadPythonModule (const UT_StringHolder &path, bool reregister, UT_WorkBuffer &errors)
	Reloads a Python module by name. More...

BaseType *	registeredType (PDG_RegistrationTypetype, const UT_StringHolder &name) const
	Returns a generic type object for a given registered type and typename. More...

void	deprecateType (PDG_RegistrationTypetype, const UT_StringHolder &name)
	Deprecated a type name, so that accessing it will issue an warning. More...

UT_StringArray	typeNames (PDG_RegistrationTypetype, bool include_aliases=false) const
	Returns the set of all existing type names for registered type. More...

Static Public Member Functions
static PDG_TypeRegistry *	types ()
	Returns the static type registry instance. More...

static bool	isSchedulerLocal (const UT_StringHolder &type_name)

Protected Member Functions
	PDG_TypeRegistry ()

Protected Member Functions inherited from PDGT_TypeRegistry< PDG_RegistrationType,(int) PDG_RegistrationType::eCount >
	PDGT_TypeRegistry (const UT_StringHolder &dso_function, const UT_StringHolder &module_name)

Additional Inherited Members
Public Types inherited from PDGT_TypeRegistry< PDG_RegistrationType,(int) PDG_RegistrationType::eCount >
using	Self = PDGT_TypeRegistry< PDG_RegistrationType, EnumSize >
	Self type def. More...

Protected Types inherited from PDGT_TypeRegistry< PDG_RegistrationType,(int) PDG_RegistrationType::eCount >
using	BaseType = PDGT_BaseType< PDG_RegistrationType >
	PDGT_BaseType spiicalization for this type registry. More...

using	pdg_BaseTypePtr = UT_SharedPtr< BaseType >
	Shared ptr to a registered PDG type. More...

using	TypeMap = UT_StringMap< pdg_BaseTypePtr >
	Map of type name to shared ptr. More...

Detailed Description

Examples:: PDG/PDG_PartitionByParity.C, PDG/PDG_PartitionByParity.h, PDG/PDG_ProcessorRandom.C, and PDG/PDG_ProcessorRandom.h.

Definition at line 37 of file PDG_TypeRegistry.h.

Constructor & Destructor Documentation

PDG_TypeRegistry::PDG_TypeRegistry ( )

protected

PDG_TypeRegistry::~PDG_TypeRegistry ( )

override

Destructor.

Member Function Documentation

PDG_CustomHandlers* PDG_TypeRegistry::customHandlers ( )

inline

Returns the custom handlers table.

Definition at line 281 of file PDG_TypeRegistry.h.

PDG_WorkItemDataType* PDG_TypeRegistry::defaultWorkItemDataType ( ) const

inline

Gets/sets the default work item data type.

Definition at line 255 of file PDG_TypeRegistry.h.

PDG_DependencyType* PDG_TypeRegistry::dependencyType ( const UT_StringHolder & name ) const

Returns an external dependency type object for a given name.

PDG_FileUtils* PDG_TypeRegistry::fileUtils ( )

inline

Returns the shared file utilities object.

Definition at line 285 of file PDG_TypeRegistry.h.

PDG_SchedulerType* PDG_TypeRegistry::inProcessSchedulerType ( ) const

inline

Gets/sets the in process scheduler type.

Definition at line 267 of file PDG_TypeRegistry.h.

static bool PDG_TypeRegistry::isSchedulerLocal ( const UT_StringHolder & type_name )

static

Returns true if the scheduler name is a "local" scheduler, e.g. it does not use the farm.

const UT_StringHolder& PDG_TypeRegistry::localSchedulerTypeName ( ) const

inline

Returns the name of the local scheduler type.

Definition at line 273 of file PDG_TypeRegistry.h.

PDG_NodeCallbackType* PDG_TypeRegistry::nodeCallbackType ( const UT_StringHolder & name ) const

Retruns a node callback type object for a given name.

UT_StringHolder PDG_TypeRegistry::pySerializationModule ( ) const

Returns the name of the module used to serialize and deserialize PyObject attributes