com.esri.arcgis.trackinganalyst
Class ArrivingLocationTrigger

java.lang.Object
  com.esri.arcgis.trackinganalyst.ArrivingLocationTrigger

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IArrivingLocationTrigger, ILocationTrigger, ILocationTriggerAdmin, Serializable

public class ArrivingLocationTrigger
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArrivingLocationTrigger, ILocationTrigger, ILocationTriggerAdmin, ISupportErrorInfo

Controls the implementation of the action's location trigger for the geometrical arriving (entering) or departing (exited) a polygon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

ArrivingLocationTrigger()
Constructs a ArrivingLocationTrigger using ArcGIS Engine.

ArrivingLocationTrigger(Object obj)
Construct a ArrivingLocationTrigger using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	configure(int hParentWindowHandle, ISet piObjects) Open a configuration dialog for the location trigger properties.
boolean	equals(Object o) Compare this object with another
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.
static String	getClsid() getClsid.
String	getDescription() Description of location trigger properties.
String	getName() Name of the location trigger.
IPropertySet	getProperties() PropertySet of all configurable items for this location trigger.
IGeometry	getTestGeometry() Geometry used for location trigger test.
int	hashCode() the hashcode for this object
void	initializeState() Initializes the Location Trigger to its default state.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isHasConfigurationDialog() Indicates whether this location trigger has a Configuration Dialog or not.
boolean	isInvertable() Indicates whether or not the location trigger can be negated.
boolean	isInverted() Indicates whether or not location trigger has been negated.
boolean	isNeedsTestGeometry() Indicates whether this location trigger needs to have a test geometry.
boolean	isValidateProperties() Indicates whether this location trigger has been configured properly.
void	setEventIdColumn(int rhs1) Column containing EventID information.
void	setInverted(boolean pVal) Indicates whether or not location trigger has been negated.
void	setProperties(IPropertySet ppiProperties) PropertySet of all configurable items for this location trigger.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArrivingLocationTrigger

public ArrivingLocationTrigger()
                        throws IOException,
                               UnknownHostException

Constructs a ArrivingLocationTrigger using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArrivingLocationTrigger

public ArrivingLocationTrigger(Object obj)
                        throws IOException

Construct a ArrivingLocationTrigger using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArrivingLocationTrigger.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ArrivingLocationTrigger theArrivingLocationTrigger = (ArrivingLocationTrigger) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the location trigger.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getName in interface ILocationTrigger

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of location trigger properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getDescription in interface ILocationTrigger

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInvertable

public 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. Requires Tracking Analyst Extension.

Specified by:

isInvertable in interface ILocationTrigger

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInverted

public 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. Requires Tracking Analyst Extension.

Specified by:

isInverted in interface ILocationTrigger

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInverted

public 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. Requires Tracking Analyst Extension.

Specified by:

setInverted in interface ILocationTrigger

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeColumn

public void setShapeColumn(int rhs1)
                    throws IOException,
                           AutomationException

Column containing geometry objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setShapeColumn in interface ILocationTrigger

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventIdColumn

public void setEventIdColumn(int rhs1)
                      throws IOException,
                             AutomationException

Column containing EventID information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setEventIdColumn in interface ILocationTrigger

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTestFeatureClass

public 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. Requires Tracking Analyst Extension.

Specified by:

setTestFeatureClass in interface ILocationTrigger

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

public 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. Requires Tracking Analyst Extension.

Specified by:

geometryIsCompatible in interface ILocationTrigger

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

public void evaluateFeature(IFeature piFeature)
                     throws IOException,
                            AutomationException

Evaluates feature for location trigger information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

evaluateFeature in interface ILocationTrigger

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

public 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. Requires Tracking Analyst Extension.

Specified by:

evaluateDataMessage in interface ILocationTrigger

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTestGeometry

public void setTestGeometry(IGeometry ppiTestGeometry)
                     throws IOException,
                            AutomationException

Geometry used for location trigger test.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setTestGeometry in interface ILocationTrigger

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

public IGeometry getTestGeometry()
                          throws IOException,
                                 AutomationException

Geometry used for location trigger test.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getTestGeometry in interface ILocationTrigger

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.

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

PropertySet of all configurable items for this location trigger.

Remarks

The PropertySet should contain all of the configuration information for the Location Trigger. The supported property name-value pairs are defined by the coclass.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getProperties in interface ILocationTriggerAdmin

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperties

public void setProperties(IPropertySet ppiProperties)
                   throws IOException,
                          AutomationException

PropertySet of all configurable items for this location trigger.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setProperties in interface ILocationTriggerAdmin

Parameters:

ppiProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasConfigurationDialog

public boolean isHasConfigurationDialog()
                                 throws IOException,
                                        AutomationException

Indicates whether this location trigger has a Configuration Dialog or not.

Description

Use this property to determine if the location trigger has a dialog that can be used to generate the configuration properties. If a configuration dialog exists, it can be used in place of programmatically calling put_Properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isHasConfigurationDialog in interface ILocationTriggerAdmin

Returns:

The pbvarHasConfigurationDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValidateProperties

public boolean isValidateProperties()
                             throws IOException,
                                    AutomationException

Indicates whether this location trigger has been configured properly.

Description

ValidateProperties can be used after the configuration properties have been set, using either put_Properties or configure, to verify that the resulting location trigger is valid. If the result is returned as VARIANT_FALSE you will need to reconfigure the trigger before it will be evaluated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isValidateProperties in interface ILocationTriggerAdmin

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

configure

public void configure(int hParentWindowHandle,
                      ISet piObjects)
               throws IOException,
                      AutomationException

Open a configuration dialog for the location trigger properties. At a minimum the ISet will contain one or more of the following objects, Action to be edited, Trigger Layer, Server Connection, and Polygon Source Name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

configure in interface ILocationTriggerAdmin

Parameters:

hParentWindowHandle - The hParentWindowHandle (A COM typedef) (in)

piObjects - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNeedsTestGeometry

public boolean isNeedsTestGeometry()
                            throws IOException,
                                   AutomationException

Indicates whether this location trigger needs to have a test geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

isNeedsTestGeometry in interface ILocationTriggerAdmin

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initializeState

public void initializeState()
                     throws IOException,
                            AutomationException

Initializes the Location Trigger to its default state.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

initializeState in interface ILocationTriggerAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.