com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class MergeBranch

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.MergeBranch

All Implemented Interfaces:

GPTool

public class MergeBranch
extends AbstractGPTool

The Merge Branch tool merges two or more logical branches into a single output. The Merge Branch tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is intended for use in ModelBuilder and not in Python scripting.
• The tool looks at the list of input variables and returns the first variable that is in the has-been-run state.
• Merge Branch accepts any data type in its list of values. The output data type is Any Value, which is a generic data type. This means you can connect the output of Merge Branch to any parameter of any tool. When the connected tool is run, it expects the contents of an Any Value variable to be of the correct data type; it is up to you to make sure that the contents are correct for the tool's parameter.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MergeBranch()
Creates the Merge Branch tool with defaults.

Method Summary

Object	getInValues() Returns the In Values parameter of this tool .
Object	getOutValue() Returns the output_value parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInValues(Object inValues) Sets the In Values parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MergeBranch

public MergeBranch()

Creates the Merge Branch tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

Method Detail

getInValues

public Object getInValues()

Returns the In Values parameter of this tool . This parameter is list of values from different branches. The first ready-to-run state value in the list will be the output of the tool. This is an optional parameter.

Returns:

the In Values

setInValues

public void setInValues(Object inValues)

Sets the In Values parameter of this tool . This parameter is list of values from different branches. The first ready-to-run state value in the list will be the output of the tool. This is an optional parameter.

Parameters:

inValues - list of values from different branches. The first ready-to-run state value in the list will be the output of the tool.

getOutValue

public Object getOutValue()

Returns the output_value parameter of this tool (Read only). This is an derived parameter.

Returns:

the output_value

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias