PDG_JobScriptInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_JOB_SCRIPT_INFO_H__
#define __PDG_JOB_SCRIPT_INFO_H__

#include "PDG_API.h"

#include <UT/UT_StringArray.h>
#include <UT/UT_StringHolder.h>

class PDG_Service;
class UT_WorkBuffer;

class PDG_API PDG_JobScriptInfo
{
public:
    /// 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
    enum CommandType
    {
        /// Use the default command or the one set by the node itself
        eCommandTypeDefault,

        /// Use a custom script, but using the same interepreter and
        /// script path as normal
        eCommandTypeCustomScript,

        /// Use a fully custom command string
        eCommandTypeCustom,
    };

public:
                            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)
                                { myIsMainThread = is_main_thread; }
    void                    setIsNative(bool is_native)
                                { myIsNative = 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
                                { return myIsStandardScript; }
    bool                    isMainThread() const
                                { return myIsMainThread; }
    bool                    isNative() const
                                { return myIsNative; }

    const UT_StringHolder&  moduleName() const
                                { return myModuleName; }
    const UT_StringHolder&  pythonExecutable() const
                                { return myPythonExecutable; }
    const UT_StringHolder&  extraArgs() const
                                { return myExtraArgs; }
    const UT_StringHolder&  customCommand() const
                                { return myCustomCommand; }
    const UT_StringArray&   serviceTypeNames() const
                                { return myServiceTypeNames; }

    CommandType             commandType() const
                                { return myCommandType; }

private:
    UT_StringHolder         myModuleName;
    UT_StringHolder         myPythonExecutable;
    UT_StringHolder         myExtraArgs;
    UT_StringHolder         myCustomCommand;
    
    UT_StringArray          myServiceTypeNames;

    CommandType             myCommandType;

    bool                    myIsStandardScript;
    bool                    myIsMainThread;
    bool                    myIsNative;
};

#endif