us.temerity.pipeline.plugin.HfsReadCmdAction.v2_4_1
Class HfsReadCmdAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils
                      us.temerity.pipeline.plugin.HfsActionUtils
                          us.temerity.pipeline.plugin.HfsReadCmdAction.v2_4_1.HfsReadCmdAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class HfsReadCmdAction
extends HfsActionUtils

Generates a Houdini command script which sets a filename parameter of an operator in a Houdini scene so that it will read the files associated with a given source node.

Often it can be useful to have a master Houdini scene file used in a number of contexts where the only difference is the names of the input files being read by the scene. This action provides a way of setting these file names within the Houdini scene by generating a small Houdini command script which uses "opparm" to set the This action defines the following single valued parameters:

File Source

The source node which contains the files to be read by the given Houdini operator.

Operator Name

The name of the Houdini operator who's parameter which will be set by the generated command file.

Parameter Name

The name of the Houdini operator's parameter which will be set by the generated command file.

See Also:

Serialized Form

Field Summary

static String	aFileSource
static String	aOperatorName
static String	aParameterName

Fields inherited from class us.temerity.pipeline.plugin.HfsActionUtils

aCameraOverride, aHoudiniScene, aOutputOperator, aPostFrameScript, aPostRenderScript, aPreFrameScript, aPreRenderScript, aUseGraphicalLicense

Fields inherited from class us.temerity.pipeline.plugin.CommonActionUtils

aExtraOptions

Fields inherited from class us.temerity.pipeline.BasePlugin

pDescription

Fields inherited from class us.temerity.pipeline.PluginID

pVendor, pVersionID

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

HfsReadCmdAction()

Method Summary

SubProcessHeavy

prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

Methods inherited from class us.temerity.pipeline.plugin.HfsActionUtils

addCameraOverrideParam, addHoudiniSceneParam, addOutputOperatorParam, addPostFrameScriptParam, addPostRenderScriptParam, addPreFrameScriptParam, addPreRenderScriptParam, addScriptParamsToLayout, addScriptParamsToLayout, addUseGraphicalLicenseParam, getCommandSourcePath, getHoudiniCommandTargetPath, getHoudiniSceneSourcePath, getHoudiniSceneTargetPath, getHoudiniVersion, getHoudiniVersion, toHoudiniFilePattern, writeCameraOverrideOpparm, writePostFrameScriptOpparm, writePostRenderScriptOpparm, writePreFrameScriptOpparm, writePreRenderScriptOpparm, writeStringOpparm

Methods inherited from class us.temerity.pipeline.plugin.CommonActionUtils

addExtraOptionsParam, addExtraOptionsParamToLayout, createScriptSubProcess, createSubProcess, createSubProcess, createSubProcess, createSubProcess, createTempCopySubProcess, createTempScript, escPath, escPath, getExtraOptionsArgs, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePaths, getPrimarySourcePaths, getPrimarySourcePaths, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPaths, getPrimaryTargetPaths, getPrimaryTargetPaths, getSecondarySourceBooleanParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceEnumParamIndex, getSecondarySourceIntegerParamValue, getSecondarySourceIntegerParamValue, getSecondarySourceLongParamValue, getSecondarySourceLongParamValue, getSecondarySourceOptionalBooleanParamValue, getSecondarySourceStringParamValue, getSecondarySourceStringParamValue, getSingleBooleanParamValue, getSingleDoubleParamValue, getSingleDoubleParamValue, getSingleEnumParamIndex, getSingleIntegerParamValue, getSingleIntegerParamValue, getSingleLongParamValue, getSingleLongParamValue, getSingleOptionalBooleanParamValue, getSingleStringParamValue, getSingleStringParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSourceBooleanParamValue, getSourceDoubleParamValue, getSourceDoubleParamValue, getSourceEnumParamIndex, getSourceIntegerParamValue, getSourceIntegerParamValue, getSourceLongParamValue, getSourceLongParamValue, getSourceOptionalBooleanParamValue, getSourceStringParamValue, getSourceStringParamValue, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePaths

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, getInitialSourceParams, getPluginType, getPresetChoices, getPresetValues, getSecondarySequences, getSecondarySourceNames, getSecondarySourceParam, getSecondarySourceParams, getSecondarySourceParamValue, getSingleLayout, getSingleParam, getSingleParams, getSingleParamValue, getSourceLayout, getSourceNames, getSourceParam, getSourceParams, getSourceParamValue, getTempDir, getTempPath, hasSecondarySourceParams, hasSingleParams, hasSourceParams, initSecondarySourceParams, initSourceParams, removeAllSourceParams, removeSecondarySourceParams, removeSecondarySourceParams, removeSourceParams, setSecondarySourceParamValue, setSingleLayout, setSingleParamValue, setSingleParamValues, setSourceLayout, setSourceParamValue, setSourceParamValues, supportsSourceParams, toGlue

Methods inherited from class us.temerity.pipeline.BasePlugin

addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment

Methods inherited from class us.temerity.pipeline.PluginID

getVendor, getVersionID

Methods inherited from class us.temerity.pipeline.Named

getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

aFileSource

public static final String aFileSource

See Also:

Constant Field Values

aOperatorName

public static final String aOperatorName

See Also:

Constant Field Values

aParameterName

public static final String aParameterName

See Also:

Constant Field Values

Constructor Detail

HfsReadCmdAction

public HfsReadCmdAction()

Method Detail

prep

public SubProcessHeavy prep(ActionAgenda agenda,
                            File outFile,
                            File errFile)
                     throws PipelineException

Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

Overrides:

prep in class BaseAction

Parameters:

agenda - The agenda to be accomplished by the action.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Returns:

The SubProcess which will fulfill the agenda.

Throws:

PipelineException - If unable to prepare a SubProcess due to illegal, missing or imcompatable information in the action agenda or a general failure of the prep method code.