com.esri.arcgis.geoprocessing.tools.linearreferencingtools
Class MakeRouteEventLayer

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

public class MakeRouteEventLayer
extends AbstractGPTool

Creates a temporary feature layer using routes and route events. When the temporary layer is used (displayed on a map, or used by another geoprocessing tool), The Make Route Event Layer tool is contained in the Linear Referencing Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MakeRouteEventLayer()
          Creates the Make Route Event Layer tool with defaults.
MakeRouteEventLayer(Object inRoutes, Object routeIdField, Object inTable, Object inEventProperties, Object outLayer)
          Creates the Make Route Event Layer tool with the required parameters.
 
Method Summary
 String getAddAngleField()
          Returns the Generate an angle field parameter of this tool .
 String getAddErrorField()
          Returns the Generate a field for locating errors parameter of this tool .
 String getAngleType()
          Returns the Calculated Angle Type parameter of this tool .
 String getComplementAngle()
          Returns the Write the complement of the angle to the angle field parameter of this tool .
 Object getInEventProperties()
          Returns the Event Table Properties parameter of this tool .
 Object getInRoutes()
          Returns the Input Route Features parameter of this tool .
 Object getInTable()
          Returns the Input Event Table parameter of this tool .
 String getOffsetDirection()
          Returns the Events with a positive offset will be placed to the right of the routes parameter of this tool .
 Object getOffsetField()
          Returns the Offset Field parameter of this tool .
 Object getOutLayer()
          Returns the Layer Name or Table View parameter of this tool .
 String getPointEventType()
          Returns the Point events will be generated as multipoint features parameter of this tool .
 Object getRouteIdField()
          Returns the Route Identifier Field 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.
 void setAddAngleField(String addAngleField)
          Sets the Generate an angle field parameter of this tool .
 void setAddErrorField(String addErrorField)
          Sets the Generate a field for locating errors parameter of this tool .
 void setAngleType(String angleType)
          Sets the Calculated Angle Type parameter of this tool .
 void setComplementAngle(String complementAngle)
          Sets the Write the complement of the angle to the angle field parameter of this tool .
 void setInEventProperties(Object inEventProperties)
          Sets the Event Table Properties parameter of this tool .
 void setInRoutes(Object inRoutes)
          Sets the Input Route Features parameter of this tool .
 void setInTable(Object inTable)
          Sets the Input Event Table parameter of this tool .
 void setOffsetDirection(String offsetDirection)
          Sets the Events with a positive offset will be placed to the right of the routes parameter of this tool .
 void setOffsetField(Object offsetField)
          Sets the Offset Field parameter of this tool .
 void setOutLayer(Object outLayer)
          Sets the Layer Name or Table View parameter of this tool .
 void setPointEventType(String pointEventType)
          Sets the Point events will be generated as multipoint features parameter of this tool .
 void setRouteIdField(Object routeIdField)
          Sets the Route Identifier 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

MakeRouteEventLayer

public MakeRouteEventLayer()
Creates the Make Route Event Layer tool with defaults.

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


MakeRouteEventLayer

public MakeRouteEventLayer(Object inRoutes,
                           Object routeIdField,
                           Object inTable,
                           Object inEventProperties,
                           Object outLayer)
Creates the Make Route Event 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:
inRoutes - Feature Layer, the route features upon which events will be located.
routeIdField - Field, the field containing values that uniquely identify each route.
inTable - Table View, the table whose rows will be located along routes.
inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE.
outLayer - Feature Layer, the layer to be created. This layer is stored in memory, so a path is not necessary.
Method Detail

getInRoutes

public Object getInRoutes()
Returns the Input Route Features parameter of this tool . This parameter is Feature Layer, the route features upon which events will be located. This is a required parameter.

Returns:
the Input Route Features

setInRoutes

public void setInRoutes(Object inRoutes)
Sets the Input Route Features parameter of this tool . This parameter is Feature Layer, the route features upon which events will be located. This is a required parameter.

Parameters:
inRoutes - Feature Layer, the route features upon which events will be located.

getRouteIdField

public Object getRouteIdField()
Returns the Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identify each route. This is a required parameter.

Returns:
the Route Identifier Field

setRouteIdField

public void setRouteIdField(Object routeIdField)
Sets the Route Identifier Field parameter of this tool . This parameter is Field, the field containing values that uniquely identify each route. This is a required parameter.

Parameters:
routeIdField - Field, the field containing values that uniquely identify each route.

getInTable

public Object getInTable()
Returns the Input Event Table parameter of this tool . This parameter is Table View, the table whose rows will be located along routes. This is a required parameter.

Returns:
the Input Event Table

setInTable

public void setInTable(Object inTable)
Sets the Input Event Table parameter of this tool . This parameter is Table View, the table whose rows will be located along routes. This is a required parameter.

Parameters:
inTable - Table View, the table whose rows will be located along routes.

getInEventProperties

public Object getInEventProperties()
Returns the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE. This is a required parameter.

Returns:
the Event Table Properties

setInEventProperties

public void setInEventProperties(Object inEventProperties)
Sets the Event Table Properties parameter of this tool . This parameter is Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE. This is a required parameter.

Parameters:
inEventProperties - Route Measure Event Properties, to-Measure FieldA field containing measure values. This field must be numeric and is required when the event type is LINE.

getOutLayer

public Object getOutLayer()
Returns the Layer Name or Table View parameter of this tool . This parameter is Feature Layer, the layer to be created. This layer is stored in memory, so a path is not necessary. This is a required parameter.

Returns:
the Layer Name or Table View

setOutLayer

public void setOutLayer(Object outLayer)
Sets the Layer Name or Table View parameter of this tool . This parameter is Feature Layer, the layer to be created. This layer is stored in memory, so a path is not necessary. This is a required parameter.

Parameters:
outLayer - Feature Layer, the layer to be created. This layer is stored in memory, so a path is not necessary.

getOffsetField

public Object getOffsetField()
Returns the Offset Field parameter of this tool . This parameter is Field, the field containing values used to offset events from their underlying route. This field must be numeric. This is an optional parameter.

Returns:
the Offset Field

setOffsetField

public void setOffsetField(Object offsetField)
Sets the Offset Field parameter of this tool . This parameter is Field, the field containing values used to offset events from their underlying route. This field must be numeric. This is an optional parameter.

Parameters:
offsetField - Field, the field containing values used to offset events from their underlying route. This field must be numeric.

getAddErrorField

public String getAddErrorField()
Returns the Generate a field for locating errors parameter of this tool . This parameter is String, specifies whether a field named LOC_ERROR will be added to the temporary layer that is created. This is an optional parameter.

Returns:
the Generate a field for locating errors

setAddErrorField

public void setAddErrorField(String addErrorField)
Sets the Generate a field for locating errors parameter of this tool . This parameter is String, specifies whether a field named LOC_ERROR will be added to the temporary layer that is created. This is an optional parameter.

Parameters:
addErrorField - String, specifies whether a field named LOC_ERROR will be added to the temporary layer that is created.

getAddAngleField

public String getAddAngleField()
Returns the Generate an angle field parameter of this tool . This parameter is String, specifies whether a field named LOC_ANGLE will be added to the temporary layer that is created. This parameter is only valid when the event type is POINT. This is an optional parameter.

Returns:
the Generate an angle field

setAddAngleField

public void setAddAngleField(String addAngleField)
Sets the Generate an angle field parameter of this tool . This parameter is String, specifies whether a field named LOC_ANGLE will be added to the temporary layer that is created. This parameter is only valid when the event type is POINT. This is an optional parameter.

Parameters:
addAngleField - String, specifies whether a field named LOC_ANGLE will be added to the temporary layer that is created. This parameter is only valid when the event type is POINT.

getAngleType

public String getAngleType()
Returns the Calculated Angle Type parameter of this tool . This parameter is String, specifies the type of locating angle that will be calculated. This parameter is only valid if ANGLE_FIELD has been specified. This is an optional parameter.

Returns:
the Calculated Angle Type

setAngleType

public void setAngleType(String angleType)
Sets the Calculated Angle Type parameter of this tool . This parameter is String, specifies the type of locating angle that will be calculated. This parameter is only valid if ANGLE_FIELD has been specified. This is an optional parameter.

Parameters:
angleType - String, specifies the type of locating angle that will be calculated. This parameter is only valid if ANGLE_FIELD has been specified.

getComplementAngle

public String getComplementAngle()
Returns the Write the complement of the angle to the angle field parameter of this tool . This parameter is String, specifies whether the complement of the locating angle will be calculated. This parameter is only valid if ANGLE_FIELD has been specified. This is an optional parameter.

Returns:
the Write the complement of the angle to the angle field

setComplementAngle

public void setComplementAngle(String complementAngle)
Sets the Write the complement of the angle to the angle field parameter of this tool . This parameter is String, specifies whether the complement of the locating angle will be calculated. This parameter is only valid if ANGLE_FIELD has been specified. This is an optional parameter.

Parameters:
complementAngle - String, specifies whether the complement of the locating angle will be calculated. This parameter is only valid if ANGLE_FIELD has been specified.

getOffsetDirection

public String getOffsetDirection()
Returns the Events with a positive offset will be placed to the right of the routes parameter of this tool . This parameter is String, specifies the side on which the route events with a positive offset are displayed. This parameter is only valid if an offset field has been specified. This is an optional parameter.

Returns:
the Events with a positive offset will be placed to the right of the routes

setOffsetDirection

public void setOffsetDirection(String offsetDirection)
Sets the Events with a positive offset will be placed to the right of the routes parameter of this tool . This parameter is String, specifies the side on which the route events with a positive offset are displayed. This parameter is only valid if an offset field has been specified. This is an optional parameter.

Parameters:
offsetDirection - String, specifies the side on which the route events with a positive offset are displayed. This parameter is only valid if an offset field has been specified.

getPointEventType

public String getPointEventType()
Returns the Point events will be generated as multipoint features parameter of this tool . This parameter is String, specifies whether point events will be treated as point features or multipoint features. This is an optional parameter.

Returns:
the Point events will be generated as multipoint features

setPointEventType

public void setPointEventType(String pointEventType)
Sets the Point events will be generated as multipoint features parameter of this tool . This parameter is String, specifies whether point events will be treated as point features or multipoint features. This is an optional parameter.

Parameters:
pointEventType - String, specifies whether point events will be treated as point features or multipoint features.

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