com.esri.arcgis.geoprocessing.tools.trackinganalysttools
Class MakeTrackingLayer

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.trackinganalysttools.MakeTrackingLayer
All Implemented Interfaces:
GPTool

public class MakeTrackingLayer
extends AbstractGPTool

This tool creates a tracking layer from a feature class or layer containing temporal data. The Make Tracking Layer tool is contained in the Tracking Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeTrackingLayer()
          Creates the Make Tracking Layer tool with defaults.
MakeTrackingLayer(Object inFeatures, Object outLayerName, String adjustedForDst, String storagePolicy, Object timeField)
          Creates the Make Tracking Layer tool with the required parameters.
 
Method Summary
 String getAdjustedForDst()
          Returns the Time field values are adjusted for Daylight Saving Time parameter of this tool .
 String getAmDesignator()
          Returns the AM Designator parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getOutLayer()
          Returns the Output Layer parameter of this tool (Read only).
 Object getOutLayerName()
          Returns the Output Layer Name parameter of this tool .
 String getPmDesignator()
          Returns the PM Designator parameter of this tool .
 int getStandardStringFormat()
          Returns the Locale parameter of this tool .
 String getStoragePolicy()
          Returns the Storage Policy parameter of this tool .
 Object getTimeField()
          Returns the Time Field parameter of this tool .
 String getTimeFieldFormat()
          Returns the Time Field Format parameter of this tool .
 String getTimeZone()
          Returns the Time Zone parameter of this tool .
 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.
 Object getTrackIdField()
          Returns the Track ID Field parameter of this tool .
 void setAdjustedForDst(String adjustedForDst)
          Sets the Time field values are adjusted for Daylight Saving Time parameter of this tool .
 void setAmDesignator(String amDesignator)
          Sets the AM Designator parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setOutLayerName(Object outLayerName)
          Sets the Output Layer Name parameter of this tool .
 void setPmDesignator(String pmDesignator)
          Sets the PM Designator parameter of this tool .
 void setStandardStringFormat(int standardStringFormat)
          Sets the Locale parameter of this tool .
 void setStoragePolicy(String storagePolicy)
          Sets the Storage Policy parameter of this tool .
 void setTimeField(Object timeField)
          Sets the Time Field parameter of this tool .
 void setTimeFieldFormat(String timeFieldFormat)
          Sets the Time Field Format parameter of this tool .
 void setTimeZone(String timeZone)
          Sets the Time Zone parameter of this tool .
 void setTrackIdField(Object trackIdField)
          Sets the Track ID Field 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

MakeTrackingLayer

public MakeTrackingLayer()
Creates the Make Tracking Layer tool with defaults.

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


MakeTrackingLayer

public MakeTrackingLayer(Object inFeatures,
                         Object outLayerName,
                         String adjustedForDst,
                         String storagePolicy,
                         Object timeField)
Creates the Make Tracking Layer tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inFeatures - the input feature class or layer.
outLayerName - the name of the output tracking layer.
adjustedForDst - null
storagePolicy - determines the storage policy for the output tracking layer.
timeField - the field in the input feature class or layer that contains date and time information. This tool requires date and time information to be contained in the same field, and the data type of the field must be Short, Long, Float, Double, Text, or Date.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the input feature class or layer. This is a required parameter.

Returns:
the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Features parameter of this tool . This parameter is the input feature class or layer. This is a required parameter.

Parameters:
inFeatures - the input feature class or layer.

getOutLayerName

public Object getOutLayerName()
Returns the Output Layer Name parameter of this tool . This parameter is the name of the output tracking layer. This is a required parameter.

Returns:
the Output Layer Name

setOutLayerName

public void setOutLayerName(Object outLayerName)
Sets the Output Layer Name parameter of this tool . This parameter is the name of the output tracking layer. This is a required parameter.

Parameters:
outLayerName - the name of the output tracking layer.

getTimeZone

public String getTimeZone()
Returns the Time Zone parameter of this tool . This parameter is the time zone that the data in the input feature class was recorded in. For a list of available time zones supported by your system, open the tool dialog box and expand this drop-down. Time Zone IDs assigned by Microsoft may also be used instead of the string representation. This is an optional parameter.

Returns:
the Time Zone

setTimeZone

public void setTimeZone(String timeZone)
Sets the Time Zone parameter of this tool . This parameter is the time zone that the data in the input feature class was recorded in. For a list of available time zones supported by your system, open the tool dialog box and expand this drop-down. Time Zone IDs assigned by Microsoft may also be used instead of the string representation. This is an optional parameter.

Parameters:
timeZone - the time zone that the data in the input feature class was recorded in. For a list of available time zones supported by your system, open the tool dialog box and expand this drop-down. Time Zone IDs assigned by Microsoft may also be used instead of the string representation.

getAdjustedForDst

public String getAdjustedForDst()
Returns the Time field values are adjusted for Daylight Saving Time parameter of this tool . This is a required parameter.

Returns:
the Time field values are adjusted for Daylight Saving Time

setAdjustedForDst

public void setAdjustedForDst(String adjustedForDst)
Sets the Time field values are adjusted for Daylight Saving Time parameter of this tool . This is a required parameter.

Parameters:
adjustedForDst - null

getStoragePolicy

public String getStoragePolicy()
Returns the Storage Policy parameter of this tool . This parameter is determines the storage policy for the output tracking layer. This is a required parameter.

Returns:
the Storage Policy

setStoragePolicy

public void setStoragePolicy(String storagePolicy)
Sets the Storage Policy parameter of this tool . This parameter is determines the storage policy for the output tracking layer. This is a required parameter.

Parameters:
storagePolicy - determines the storage policy for the output tracking layer.

getTimeField

public Object getTimeField()
Returns the Time Field parameter of this tool . This parameter is the field in the input feature class or layer that contains date and time information. This tool requires date and time information to be contained in the same field, and the data type of the field must be Short, Long, Float, Double, Text, or Date. This is a required parameter.

Returns:
the Time Field

setTimeField

public void setTimeField(Object timeField)
Sets the Time Field parameter of this tool . This parameter is the field in the input feature class or layer that contains date and time information. This tool requires date and time information to be contained in the same field, and the data type of the field must be Short, Long, Float, Double, Text, or Date. This is a required parameter.

Parameters:
timeField - the field in the input feature class or layer that contains date and time information. This tool requires date and time information to be contained in the same field, and the data type of the field must be Short, Long, Float, Double, Text, or Date.

getTimeFieldFormat

public String getTimeFieldFormat()
Returns the Time Field Format parameter of this tool . This is an optional parameter.

Returns:
the Time Field Format

setTimeFieldFormat

public void setTimeFieldFormat(String timeFieldFormat)
Sets the Time Field Format parameter of this tool . This is an optional parameter.

Parameters:
timeFieldFormat - null

getStandardStringFormat

public int getStandardStringFormat()
Returns the Locale parameter of this tool . This is an optional parameter.

Returns:
the Locale

setStandardStringFormat

public void setStandardStringFormat(int standardStringFormat)
Sets the Locale parameter of this tool . This is an optional parameter.

Parameters:
standardStringFormat - null

getAmDesignator

public String getAmDesignator()
Returns the AM Designator parameter of this tool . This parameter is if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate AM in the time field data values. If nothing is entered, then the default AM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed. This is an optional parameter.

Returns:
the AM Designator

setAmDesignator

public void setAmDesignator(String amDesignator)
Sets the AM Designator parameter of this tool . This parameter is if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate AM in the time field data values. If nothing is entered, then the default AM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed. This is an optional parameter.

Parameters:
amDesignator - if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate AM in the time field data values. If nothing is entered, then the default AM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed.

getPmDesignator

public String getPmDesignator()
Returns the PM Designator parameter of this tool . This parameter is if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate PM in the time field data values. If nothing is entered, then the default PM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed. This is an optional parameter.

Returns:
the PM Designator

setPmDesignator

public void setPmDesignator(String pmDesignator)
Sets the PM Designator parameter of this tool . This parameter is if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate PM in the time field data values. If nothing is entered, then the default PM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed. This is an optional parameter.

Parameters:
pmDesignator - if the time field data type is Text and the time format is a 12-hour clock representation including a time marker ("t" or "tt"), then this parameter determines the character ("t") or characters ("tt") that designate PM in the time field data values. If nothing is entered, then the default PM designator for the selected locale will be used. For all time field data types other than Text, this parameter is not needed.

getTrackIdField

public Object getTrackIdField()
Returns the Track ID Field parameter of this tool . This parameter is the field that contains data values that will be used to group features into tracks in the output tracking layer. The data type of the field can be Short, Long, Float, Double, Text, or OID. This is an optional parameter.

Returns:
the Track ID Field

setTrackIdField

public void setTrackIdField(Object trackIdField)
Sets the Track ID Field parameter of this tool . This parameter is the field that contains data values that will be used to group features into tracks in the output tracking layer. The data type of the field can be Short, Long, Float, Double, Text, or OID. This is an optional parameter.

Parameters:
trackIdField - the field that contains data values that will be used to group features into tracks in the output tracking layer. The data type of the field can be Short, Long, Float, Double, Text, or OID.

getOutLayer

public Object getOutLayer()
Returns the Output Layer parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Layer

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