com.esri.arcgis.carto
Interface ILocationTrigger

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArrivingLocationTrigger, CrossingLocationTrigger, ProximityLocationTrigger

public interface ILocationTrigger
extends Serializable

Provides access to properties and methods needed to manage action's location trigger. A location trigger allows developers to extend location based triggering of actions, e.g., extend location trigger to include crosses or departing / arriving.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	evaluateDataMessage(IDataMessage piDataMessage) Evaluates data message for location trigger information.
void	evaluateFeature(IFeature piFeature) Evaluates feature for location trigger information.
void	geometryIsCompatible(int eTypeA, int eTypeB) Determines whether or not the geometry is compatible for the location trigger.
String	getDescription() Description of location trigger properties.
String	getName() Name of the location trigger.
IGeometry	getTestGeometry() Geometry used for location trigger test.
boolean	isInvertable() Indicates whether or not the location trigger can be negated.
boolean	isInverted() Indicates whether or not location trigger has been negated.
void	setEventIdColumn(int rhs1) Column containing EventID information.
void	setInverted(boolean pVal) Indicates whether or not location trigger has been negated.
void	setShapeColumn(int rhs1) Column containing geometry objects.
void	setTestFeatureClass(IFeatureClass rhs1) Feature class containing geometry used in the location query.
void	setTestGeometry(IGeometry ppiTestGeometry) Geometry used for location trigger test.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the location trigger.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of location trigger properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInvertable

boolean isInvertable()
                     throws IOException,
                            AutomationException

Indicates whether or not the location trigger can be negated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInverted

boolean isInverted()
                   throws IOException,
                          AutomationException

Indicates whether or not location trigger has been negated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInverted

void setInverted(boolean pVal)
                 throws IOException,
                        AutomationException

Indicates whether or not location trigger has been negated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeColumn

void setShapeColumn(int rhs1)
                    throws IOException,
                           AutomationException

Column containing geometry objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventIdColumn

void setEventIdColumn(int rhs1)
                      throws IOException,
                             AutomationException

Column containing EventID information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTestFeatureClass

void setTestFeatureClass(IFeatureClass rhs1)
                         throws IOException,
                                AutomationException

Feature class containing geometry used in the location query.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geometryIsCompatible

void geometryIsCompatible(int eTypeA,
                          int eTypeB)
                          throws IOException,
                                 AutomationException

Determines whether or not the geometry is compatible for the location trigger.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

eTypeA - A com.esri.arcgis.geometry.esriGeometryType constant (in)

eTypeB - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

evaluateFeature

void evaluateFeature(IFeature piFeature)
                     throws IOException,
                            AutomationException

Evaluates feature for location trigger information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

piFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

evaluateDataMessage

void evaluateDataMessage(IDataMessage piDataMessage)
                         throws IOException,
                                AutomationException

Evaluates data message for location trigger information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

piDataMessage - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTestGeometry

void setTestGeometry(IGeometry ppiTestGeometry)
                     throws IOException,
                            AutomationException

Geometry used for location trigger test.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppiTestGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTestGeometry

IGeometry getTestGeometry()
                          throws IOException,
                                 AutomationException

Geometry used for location trigger test.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.