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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.trackinganalysttools.MakeTrackingLayer

All Implemented Interfaces:

GPTool

public class MakeTrackingLayer
extends AbstractGPTool

Adds a feature dataset as a new tracking layer to you ArcMap session. The feature dataset must have a date and time field and a unique identifier field. The Make Tracking Layer tool is contained in the Tracking Analyst Tools tool box.

Software restrictions: none

Usage tips:

• The Date Field must contain both the date and time for the event
• If the date field is string type then you must specify what format the date and time are in
• The following environment settings affect this tool: Current workspace;

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 featureClass, Object dateField)
Creates the Make Tracking Layer tool with the required parameters.

Method Summary

String	getAM() Returns the AM Designator parameter of this tool .
Object	getDateField() Returns the Select Date Field parameter of this tool .
String	getDateFormat() Returns the Date Format parameter of this tool .
Object	getFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getOutputLayer() Returns the Output Temporal Layer parameter of this tool (Read only).
String	getOutputLayerName() Returns the Output Temporal Layer Name parameter of this tool .
String	getPM() Returns the PM Designator parameter of this tool .
String	getTimeFormat() Returns the Time Format 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	getTrackField() Returns the Select Track ID Field parameter of this tool .
void	setAM(String aM) Sets the AM Designator parameter of this tool .
void	setDateField(Object dateField) Sets the Select Date Field parameter of this tool .
void	setDateFormat(String dateFormat) Sets the Date Format parameter of this tool .
void	setFeatureClass(Object featureClass) Sets the Input Feature Class parameter of this tool .
void	setOutputLayerName(String outputLayerName) Sets the Output Temporal Layer Name parameter of this tool .
void	setPM(String pM) Sets the PM Designator parameter of this tool .
void	setTimeFormat(String timeFormat) Sets the Time Format parameter of this tool .
void	setTrackField(Object trackField) Sets the Select 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 featureClass,
                         Object dateField)

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:

featureClass - null

dateField - null

Method Detail

getFeatureClass

public Object getFeatureClass()

Returns the Input Feature Class parameter of this tool . This is a required parameter.

Returns:

the Input Feature Class

setFeatureClass

public void setFeatureClass(Object featureClass)

Sets the Input Feature Class parameter of this tool . This is a required parameter.

Parameters:

featureClass - null

getDateField

public Object getDateField()

Returns the Select Date Field parameter of this tool . This is a required parameter.

Returns:

the Select Date Field

setDateField

public void setDateField(Object dateField)

Sets the Select Date Field parameter of this tool . This is a required parameter.

Parameters:

dateField - null

getTrackField

public Object getTrackField()

Returns the Select Track ID Field parameter of this tool . This is an optional parameter.

Returns:

the Select Track ID Field

setTrackField

public void setTrackField(Object trackField)

Sets the Select Track ID Field parameter of this tool . This is an optional parameter.

Parameters:

trackField - null

getOutputLayerName

public String getOutputLayerName()

Returns the Output Temporal Layer Name parameter of this tool . This is an optional parameter.

Returns:

the Output Temporal Layer Name

setOutputLayerName

public void setOutputLayerName(String outputLayerName)

Sets the Output Temporal Layer Name parameter of this tool . This is an optional parameter.

Parameters:

outputLayerName - null

getTimeFormat

public String getTimeFormat()

Returns the Time Format parameter of this tool . This is an optional parameter.

Returns:

the Time Format

setTimeFormat

public void setTimeFormat(String timeFormat)

Sets the Time Format parameter of this tool . This is an optional parameter.

Parameters:

timeFormat - null

getDateFormat

public String getDateFormat()

Returns the Date Format parameter of this tool . This is an optional parameter.

Returns:

the Date Format

setDateFormat

public void setDateFormat(String dateFormat)

Sets the Date Format parameter of this tool . This is an optional parameter.

Parameters:

dateFormat - null

getAM

public String getAM()

Returns the AM Designator parameter of this tool . This parameter is String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for AM. This is an optional parameter.

Returns:

the AM Designator

setAM

public void setAM(String aM)

Sets the AM Designator parameter of this tool . This parameter is String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for AM. This is an optional parameter.

Parameters:

aM - String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for AM.

getPM

public String getPM()

Returns the PM Designator parameter of this tool . This parameter is String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for PM. This is an optional parameter.

Returns:

the PM Designator

setPM

public void setPM(String pM)

Sets the PM Designator parameter of this tool . This parameter is String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for PM. This is an optional parameter.

Parameters:

pM - String, if the date field is a string type rather than a date type, then you must specify the format for the time. If the time contains an AM/PM componant instead of a 24 hour clock representation, then you must specify the characters used for PM.

getOutputLayer

public Object getOutputLayer()

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

Returns:

the Output Temporal 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