com.esri.arcgis.trackinganalyst
Interface IEventRenderer2

All Superinterfaces:

Serializable

All Known Implementing Classes:

EnhancedInfoRenderer

public interface IEventRenderer2
extends Serializable

Provides access to properties that support rendering specific event IDs or feature IDs, in coordination with the StepTool.

Product Availability

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

Method Summary

String	getEventIDFieldName() Provides the field name that holds the Event ID; this should be consistent with that available from the temporal layer or the temporal feature class.
IStringArray	getEventIDsToRender() Provides the set of Event IDs that will be rendered in coordination with the StepTool.
IFIDSet	getFIDsToRender() Provides the set of FeatureIDs that will be rendered in coordination with the StepTool.
String	getTemporalFieldName() Provides the field name that holds the layer's temporal field; this should be consistent with that available from the temporal layer or the temporal feature class.
void	setEventIDFieldName(String pbstrEventIDField) Provides the field name that holds the Event ID; this should be consistent with that available from the temporal layer or the temporal feature class.
void	setEventIDsToRenderByRef(IStringArray ppiEventIDs) Provides the set of Event IDs that will be rendered in coordination with the StepTool.
void	setFIDsToRenderByRef(IFIDSet ppiFIDs) Provides the set of FeatureIDs that will be rendered in coordination with the StepTool.
void	setTemporalFieldName(String pbstrTemporalField) Provides the field name that holds the layer's temporal field; this should be consistent with that available from the temporal layer or the temporal feature class.

Method Detail

getFIDsToRender

IFIDSet getFIDsToRender()
                        throws IOException,
                               AutomationException

Provides the set of FeatureIDs that will be rendered in coordination with the StepTool.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFIDsToRenderByRef

void setFIDsToRenderByRef(IFIDSet ppiFIDs)
                          throws IOException,
                                 AutomationException

Provides the set of FeatureIDs that will be rendered in coordination with the StepTool.

Product Availability

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

Parameters:

ppiFIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventIDsToRender

IStringArray getEventIDsToRender()
                                 throws IOException,
                                        AutomationException

Provides the set of Event IDs that will be rendered in coordination with the StepTool.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventIDsToRenderByRef

void setEventIDsToRenderByRef(IStringArray ppiEventIDs)
                              throws IOException,
                                     AutomationException

Provides the set of Event IDs that will be rendered in coordination with the StepTool.

Product Availability

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

Parameters:

ppiEventIDs - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventIDFieldName

String getEventIDFieldName()
                           throws IOException,
                                  AutomationException

Provides the field name that holds the Event ID; this should be consistent with that available from the temporal layer or the temporal feature class.

Product Availability

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

Returns:

The pbstrEventIDField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEventIDFieldName

void setEventIDFieldName(String pbstrEventIDField)
                         throws IOException,
                                AutomationException

Provides the field name that holds the Event ID; this should be consistent with that available from the temporal layer or the temporal feature class.

Product Availability

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

Parameters:

pbstrEventIDField - The pbstrEventIDField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalFieldName

String getTemporalFieldName()
                            throws IOException,
                                   AutomationException

Provides the field name that holds the layer's temporal field; this should be consistent with that available from the temporal layer or the temporal feature class.

Product Availability

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

Returns:

The pbstrTemporalField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalFieldName

void setTemporalFieldName(String pbstrTemporalField)
                          throws IOException,
                                 AutomationException

Provides the field name that holds the layer's temporal field; this should be consistent with that available from the temporal layer or the temporal feature class.

Product Availability

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

Parameters:

pbstrTemporalField - The pbstrTemporalField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.