PDG_JobScriptInfo Class Reference

#include <PDG_JobScriptInfo.h>

Public Types
enum	CommandType { eCommandTypeDefault, eCommandTypeCustomScript, eCommandTypeCustom }

Public Member Functions
	PDG_JobScriptInfo ()
void	setScriptInfo (const UT_StringHolder &module_name, const UT_StringHolder &python_module, const UT_StringHolder &extra_args)
void	setServiceCompatibility (const UT_StringArray &service_type_names)
void	setServiceCompatibility (const UT_StringHolder &service_type_name, bool compatible)
void	setIsMainThread (bool is_main_thread)
void	setIsNative (bool is_native)
void	setCommandOverride (CommandType command_type, const UT_StringHolder &custom)
bool	isServiceCompatible (const UT_StringHolder &service_type_name) const
bool	isServiceCompatible (const PDG_Service &service) const
void	formatCommand (UT_WorkBuffer &buffer) const
UT_StringHolder	formatCommand () const
bool	isStandardScript () const
bool	isMainThread () const
bool	isNative () const
const UT_StringHolder &	moduleName () const
const UT_StringHolder &	pythonExecutable () const
const UT_StringHolder &	extraArgs () const
const UT_StringHolder &	customCommand () const
const UT_StringArray &	serviceTypeNames () const
CommandType	commandType () const

Detailed Description

Definition at line 20 of file PDG_JobScriptInfo.h.

Member Enumeration Documentation

enum PDG_JobScriptInfo::CommandType

Enumeration of possible command override types. By default, nodes will be configured to use the standard command. But it's possible to override the script or entire commandline in a specific node instance

Enumerator
eCommandTypeDefault	Use the default command or the one set by the node itself.
eCommandTypeCustomScript	Use a custom script, but using the same interepreter and script path as normal
eCommandTypeCustom	Use a fully custom command string.

Definition at line 27 of file PDG_JobScriptInfo.h.

Constructor & Destructor Documentation

PDG_JobScriptInfo::PDG_JobScriptInfo

(

)

Member Function Documentation

CommandType PDG_JobScriptInfo::commandType ( ) const

inline

Definition at line 88 of file PDG_JobScriptInfo.h.

const UT_StringHolder& PDG_JobScriptInfo::customCommand ( ) const

inline

Definition at line 83 of file PDG_JobScriptInfo.h.

const UT_StringHolder& PDG_JobScriptInfo::extraArgs ( ) const

inline

Definition at line 81 of file PDG_JobScriptInfo.h.

void PDG_JobScriptInfo::formatCommand

(

UT_WorkBuffer &

buffer

)

const

UT_StringHolder PDG_JobScriptInfo::formatCommand

(

)

const

bool PDG_JobScriptInfo::isMainThread ( ) const

inline

Definition at line 72 of file PDG_JobScriptInfo.h.

bool PDG_JobScriptInfo::isNative ( ) const

inline

Definition at line 74 of file PDG_JobScriptInfo.h.

bool PDG_JobScriptInfo::isServiceCompatible

(

const UT_StringHolder &

service_type_name

)

const

bool PDG_JobScriptInfo::isServiceCompatible

(

const PDG_Service &

service

)

const

bool PDG_JobScriptInfo::isStandardScript ( ) const

inline

Definition at line 70 of file PDG_JobScriptInfo.h.

const UT_StringHolder& PDG_JobScriptInfo::moduleName ( ) const

inline

Definition at line 77 of file PDG_JobScriptInfo.h.

const UT_StringHolder& PDG_JobScriptInfo::pythonExecutable ( ) const

inline

Definition at line 79 of file PDG_JobScriptInfo.h.

const UT_StringArray& PDG_JobScriptInfo::serviceTypeNames ( ) const

inline

Definition at line 85 of file PDG_JobScriptInfo.h.

void PDG_JobScriptInfo::setCommandOverride	(	CommandType	command_type,
		const UT_StringHolder &	custom
	)

void PDG_JobScriptInfo::setIsMainThread ( bool  is_main_thread )

inline

Definition at line 53 of file PDG_JobScriptInfo.h.

void PDG_JobScriptInfo::setIsNative ( bool  is_native )

inline

Definition at line 55 of file PDG_JobScriptInfo.h.

void PDG_JobScriptInfo::setScriptInfo	(	const UT_StringHolder &	module_name,
		const UT_StringHolder &	python_module,
		const UT_StringHolder &	extra_args
	)

void PDG_JobScriptInfo::setServiceCompatibility

(

const UT_StringArray &

service_type_names

)

void PDG_JobScriptInfo::setServiceCompatibility	(	const UT_StringHolder &	service_type_name,
		bool	compatible
	)

---

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

• PDG/PDG_JobScriptInfo.h